Skip to content

Conversation

teddygroves
Copy link
Member

This change adds some more information into the pyproject.toml file

@Midnighter
Copy link
Member

If we want to turn this into a real installable package, I propose applying a package cookiecutter to get started. What do you think?

@teddygroves
Copy link
Member Author

Definitely agree - is there one you have in mind or generally prefer?

@teddygroves
Copy link
Member Author

I found your cookiecutter cookiecutter-python-package and it seems like a good fit!

@teddygroves
Copy link
Member Author

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?

@Midnighter
Copy link
Member

I found your cookiecutter cookiecutter-python-package and it seems like a good fit!

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.

@teddygroves teddygroves mentioned this pull request Dec 12, 2023
@teddygroves teddygroves changed the title Update pyproject.toml Create python package Dec 15, 2023
Copy link
Member

@Midnighter Midnighter left a 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
Copy link
Member

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"]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants