Convert packaging lesson to use pyproject.toml instead #235
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dpshelio
approved these changes
Nov 22, 2023
| version="0.1.0", | ||
| packages=find_packages(), | ||
| ) | ||
| [tool.setuptools_scm] |
There was a problem hiding this comment.
We do - if you depend on setuptools_scm, you need to specify tools.setuptools_scm in the pyproject, even if you want to use the defaults 😢
Though in practice, we're not using dynamic versioning here so we could just remove setuptools_scm from the build-requires, and also remove this line - whichever you prefer. Doing it this way will mean that dynamic versioning will work out of the box and not give any bizarre version-fetch fails. So I threw it in so that students have a template that will work if they do choose to dynamically version in their own projects 😄
Co-authored-by: David Pérez-Suárez <d.perez-suarez@ucl.ac.uk>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #234 |
Updates the week 7 notes on packaging to use
pyproject.tomlrather thansetup.py.Assumes that notebooks are still running on the original directory structure. Also throws in a mention that some major packages might not have switched from
setup.pytopyproject.toml: in which case students should see some similarities between the two formats and fields used in each.