Rename version file to Python #368
Merged
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
This simplifies all of the installation infrastructure. There were a lot of hoops to jump through to include a non-python file in a distribution. We get the same functionality and simplify our lives this way.
bayc
approved these changes
Mar 4, 2022
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.
Feature or improvement description
Currently, we store the version in a file at
floris/VERSION. Since this is not a Python file, we have to explicitly include it as a data file in setup.py. However, this doesn't work with the pip packaging as the archive on PyPI does not include the VERSION file. To be clear, FLORIS is installable viapipbecause the build happens on GitHub Actions, but PyPI also includes an archive of the source that skips the VERSION file and this archive is used by conda-forge. Therefore, the conda-forge build fails since this a required file.Rather than jumping through more hoops, it's much simpler to treat this file as source code and convert it to a Python file. This may also allow for automated versioning with git info in the future since it could be dynamically generated.
Related issue, if one exists
See the failing conda-forge build
Impacted areas of the software
conda-forge build