Modernize python build configuration #290
Open
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
MilesCranmer
commented
Apr 29, 2024
Comment on lines
+188
to
+214
| if os.path.exists(".git"): | ||
| # If on a git repository, we can | ||
| # get the version from the commit sha | ||
| kwargs = { | ||
| "use_scm_version": { | ||
| "write_to": "dedalus/version.py", | ||
| }, | ||
| "setup_requires": ["setuptools", "setuptools_scm"], | ||
| } | ||
| else: | ||
| # As a backup, we read from the pyproject.toml | ||
| import re | ||
|
|
||
| with open(os.path.join(os.path.dirname(__file__), "pyproject.toml")) as f: | ||
| data = f.read() | ||
| version = re.search(r'version = "(.*)"', data).group(1) | ||
| # TODO: When limited to Python 3.11, can use tomllib from the standard library | ||
|
|
||
| # Write the version to version.py | ||
| with open(os.path.join(os.path.dirname(__file__), "dedalus", "version.py"), "w") as f: | ||
| f.write(f'__version__ = "{version}"') | ||
|
|
||
| kwargs = { | ||
| "use_scm_version": False, | ||
| "version": version, | ||
| } | ||
|
|
There was a problem hiding this comment.
(The same one I use for PySR, so I can confirm this works!)
|
Friendly ping @kburns |
VascoSch92
reviewed
May 8, 2024
|
Ping @kburns |
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.
Moves much of setup.py to
pyproject.tomlwhich is required for many tools to install the package. It is backwards compatible though.The versioning is also handled by
pyproject.tomlnow which helps create finer-grained development versions if you are building locally (so they are not assumed to be the same as the release version).@kburns