-
Notifications
You must be signed in to change notification settings - Fork 0
Add pyproject.toml file #16
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
ahms5
left a comment
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.
nice, thank you, only minor comments
| keywords: | ||
| type: str | ||
| help: "Keywords to help categorize the project (e.g., on PyPI)." | ||
| default: "'acoustics','pyfar'" |
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.
Can we also do it here without ' to uniform it with dependencies.
| spaces between them. These dependencies will be included in the pyproject.toml file. | ||
| default: "numpy,scipy" | ||
|
|
||
| valid_python_versions: |
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.
| valid_python_versions: | |
| _valid_python_versions: |
maybe we can add _ to make clear that they are private
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.
Thank you for the review!!
I found out that adding _ to the parameters marks them as secret. This is stated on the copier website. If I understand correctly, the answers to such questions are not stored in the .copier-answers.yml file and cannot be used without being explicitly stored in another parameter.
I don't think we want that kind of behavior, so I wouldn't add a _ to the names.
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.
Alright. Sounds good
| {% set min_index = versions.index(minimum_python_version) %} | ||
| {{ versions[min_index:] }} | ||
| pypi_license_classifiers_list: |
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.
| pypi_license_classifiers_list: | |
| _pypi_license_classifiers_list: |
| EUPL-1.2: "License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)" | ||
| MPL-2.0: "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)" | ||
|
|
||
| pypi_license_classifier: |
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.
| pypi_license_classifier: | |
| _pypi_license_classifier: |
| Check out the [contributing guidelines](https://{{ project_slug }}.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar. | ||
|
|
||
|
|
||
| VALID PYTHON VERSION {{ valid_python_versions }} |
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.
what is this? I would not add it here.
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.
Oh, that wasn't supposed to be here. Thanks for noticing!
|
|
||
| project_short_description: | ||
| type: str | ||
| help: "A short description of the project. Used in the documentation" |
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.
| help: "A short description of the project. Used in the documentation" | |
| help: "A short description of the project. Used in the documentation and in the package metadata." |
| "{{ pypi_license_classifier }}", | ||
| "Natural Language :: English", | ||
| "Programming Language :: Python :: 3", | ||
| {%- for version in valid_python_versions %} |
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.
elegant
| 'description = "my_project_short_description"', | ||
| 'requires-python = ">=3.11"', | ||
| "'acoustics',", | ||
| "'pyfar'", |
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.
| "'pyfar'", | |
| "\n 'pyfar',\n", |
maybe also check if the indent is corret. This could also be applied to other paramters
Which issue(s) are closed by this pull request?
Closes #13
Changes proposed in this pull request:
pyproject.tomlto the template directory.pyproject.tomlfile, updated thetest_generated_file_exists()function.copier.yml:project_short_description,version,keywords,pypi_license_classifiers_list,pypi_license_classifier