-
Notifications
You must be signed in to change notification settings - Fork 2
Create python package #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
If we want to turn this into a real installable package, I propose applying a package cookiecutter to get started. What do you think? |
Definitely agree - is there one you have in mind or generally prefer? |
I found your cookiecutter |
OK I applied cookiecutter-python-package. As a result this PR makes some more consequential changes, in particular the licence and contact email. I went with MIT/[email protected] but I'm not 100% sure about either: @rgiessmann do you have thoughts? |
Of course, I'm biased 😉. Let me push a few minor tweaks to the cookiecutter. Since you used cruft, it will be easy to update. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall the changes look good to me. I would also be fine with requiring Python 3.11+, which would avoid some of the type annotation issues that you ran into and would allow us to use some of the more modern language constructs.
pyproject.toml
Outdated
ignore = [ | ||
"TD", # ignore flake8-todo rules | ||
"FIX", # ignore flake8-fixme rules | ||
"S101", # allow assert statements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the only exception, that I'm not fully onboard with. If this is for test cases, there is a better way.
[tool.ruff.extend-per-file-ignores]
"test_*.py" = ["S101"]
This change adds some more information into the pyproject.toml file