Replace setup.py with declarative setup.cfg #292
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
hartwork
reviewed
Jul 1, 2021
nir0s
previously approved these changes
Jul 1, 2021
sethmlarson
reviewed
Jul 1, 2021
setup.cfg
Outdated
| @@ -1,3 +1,43 @@ | |||
| [metadata] | |||
| name = distro | |||
| version = 1.5.0 | |||
There was a problem hiding this comment.
Thoughts on closing #265 by using version = attr: distro.__version__?
There was a problem hiding this comment.
I addressed the issue in PR #294.
We can't use version = attr: distro.__version__ as that would break the Sphinx configuration which parses setup.cfg to grab the version. I've taken the alternative approach of querying the installed version from distro.py. This is safer as other tools can continue to rely on setup.cfg as a source of truth.
There was a problem hiding this comment.
@sethmlarson I've applied this suggestion in the latest revision.
@hartwork This also fixes your suggestion from earlier. The docs can now be built with Python 2 again.
More review feedback welcome.
Avoid mixing code with configuration. Running setuptools no longer runs arbitrary custom code, it is all driven through a key/value configuration file, setup.cfg. This also simplifies other tools interaction. For example, the Sphinx config no longer needs to parse source code (and hope the format hasn't changed). Now, it can use the configparser library to pull values from setup.cfg.
sethmlarson
approved these changes
Jul 2, 2021
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.
Avoid mixing code with configuration.
Running setuptools no longer runs arbitrary custom code, it is all
driven through a key/value configuration file, setup.cfg.
This also simplifies other tools interaction. For example, the Sphinx
config no longer needs to parse source code (and hope the format hasn't
changed). Now, it can use the configparser library to pull values from
setup.cfg.