marcogorelli / cookiecutter-polars-plugins

Project template for Polars Plugins

Hello everybody,

I work at Quansight Labs and spend time on:

• Polars
• pandas
• assorted consulting / training

I've also written some assorted little tools:

• cython-lint (the world's first Cython linter?)
• absolufy-imports (superseded by ruff)
• nbQA (mostly superseded by ruff, but still gets ~100k downloads/month for some reason)
• auto-walrus (hopefully won't be implemented in ruff)
• polars-upgrade (the only way is up)
• polars-xdt (eXtra stuff for Dates 'n' Times)
• narwhals (🎵singing in the ocean, causing a commotion🎶)

and a tutorial on how to write Polars Plugins: https://marcogorelli.github.io/polars-plugins-tutorial/. Don't be scared

Socials:

• https://fosstodon.org/@marcogorelli
• https://www.linkedin.com/in/marcogorelli/

cookiecutter-polars-plugins's Issues

Typo in pyproject.toml

cookiecutter-polars-plugins/{{ cookiecutter.project_slug }}/pyproject.toml

Line 2 in 504bcb6

requires = ["maturin>=1.0,<2.0", "polars>=0.26.0"]

I believe it should be polars>=0.20.6 - 0.26.0 isn't released yet.

Issue with `returns_scalar` for `register_plugin`

Hello!

I tried following the instructions but I get the following error (I think I have setup the environment correctly):

(.venv) josie@...:~/code/cookiecutter-polars-plugins/minimal_plugin$ python run.py 
Traceback (most recent call last):
  File "/home/josie/code/cookiecutter-polars-plugins/minimal_plugin/run.py", line 7, in <module>
    result = df.with_columns(pig_latin = pig_latinnify('english'))
                                         ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/josie/code/cookiecutter-polars-plugins/minimal_plugin/minimal_plugin/__init__.py", line 22, in pig_latinnify
    return register_plugin(
           ^^^^^^^^^^^^^^^^
TypeError: register_plugin() missing 1 required keyword-only argument: 'returns_scalar'

Adding returns_scalar=False in https://github.com/MarcoGorelli/cookiecutter-polars-plugins/blob/main/%7B%7B%20cookiecutter.project_slug%20%7D%7D/%7B%7B%20cookiecutter.project_slug%20%7D%7D/__init__.py#L22-L27 seems to fix the issue

cookiecutter error

Hi Marco,
I'm hitting an error after running cookiecutter. Can you have a look? Thanks!

Unable to create file '.github/workflows/publish_to_pypi.yml'
Error message: 'github' is undefined
Context: {
    "_cookiecutter": {
        "author": "",
        "plugin_name": "Polars Cookiecutter",
        "project_slug": "{{ cookiecutter.plugin_name.lower().replace(' ', '_').replace('-', '_') }}"
    },
    "cookiecutter": {
        "_checkout": null,
        "_output_dir": "/Users/xxx/Desktop/project/rust/plugin",
        "_repo_dir": "cookiecutter-polars-plugins",
        "_template": "cookiecutter-polars-plugins",
        "author": "",
        "plugin_name": "test",
        "project_slug": "test"
    }
}