Unify (most) package metadata and tool configuration #73
Conversation
This file contains hidden or 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
Executable `setup.py` configuration has generally fallen out of favor, with declarative project configuration files like `setup.cfg` and `pyproject.toml` becoming more popular. The following files are subsumed by this change: * `.coveragerc` * `MANIFEST.in` * `apiron/VERSION` (thanks in part to `importlib_metadata`!) * `pytest.ini` * `requirements.txt` * `tox.ini` It also reduces `setup.py` to its minimal form. I think I would've preferred to cut over to `pyproject.toml` if we could, but [coverage does not yet support it](nedbat/coveragepy#699). This also means the configuration for `black` still sits in `pyproject.toml`, because _it_ doesn't support `setup.cfg`. Fortunately, the content of `setup.cfg` should be relatively portable to `pyproject.toml` when the time comes.
daneah
changed the title
momo-sa
reviewed
Jul 17, 2019
| @@ -1,5 +1,5 @@ | |||
| -r requirements.txt | |||
There was a problem hiding this comment.
requirements.txt is no longer relevant to dev or are we taking a different approach?
There was a problem hiding this comment.
requirements.txt has been removed in favor of setup.cfg:options:install_requires. tox packages and installs apiron in each virtual environment, so requests gets picked up as part of that process. You could optionally pip install [-e] . manually if you're doing interactive testing.
momo-sa
approved these changes
Jul 17, 2019
michael-iden
approved these changes
Jul 18, 2019
eslawski
approved these changes
Jul 18, 2019
NazimHAli
approved these changes
Jul 18, 2019
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.
This change is a: (check at least one)
Is this a breaking change? (check one)
Is the:
What does this change address?
Executable
setup.pyconfiguration has generally fallen out of favor, with declarative project configuration files likesetup.cfgandpyproject.tomlbecoming more popular. Additionally, many tools have historically used tool-specific configuration files but are slowly converging on centralized configuration instead.How does this change work?
The following files are subsumed by moving their configuration/information to
setup.cfg:.coveragercMANIFEST.inapiron/VERSION(thanks in part toimportlib_metadatafor the docs!)pytest.inirequirements.txttox.iniIt also reduces
setup.pyto its minimal form.Additional context
I think I would've preferred to cut over to
pyproject.tomlif we could, but coverage does not yet support it. This also means the configuration forblackstill sits inpyproject.toml, because it doesn't supportsetup.cfg. Fortunately, the content ofsetup.cfgshould be relatively portable topyproject.tomlwhen the time comes.