Skip to content

Simplify setup.py? #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tomschr opened this issue Apr 13, 2020 · 1 comment
Closed

Simplify setup.py? #234

tomschr opened this issue Apr 13, 2020 · 1 comment
Labels
Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness Infra All about infrastructure (GitHub Action, project build etc.) Question Unclear or open issue subject for debate Release_3.x.y Only for the major release 3

Comments

@tomschr
Copy link
Member

tomschr commented Apr 13, 2020

Situation

As we saw in issue #224, the setup.py script can be tricky. Usually, a setup.py script should describe its metadata, but should avoid any "complicated" command logic.

We had this situation already in the past: in issue #148 we discouraged the use of python setup.py test in documentation.

Proposal

I propose to remove the Tox and Clean classes in the setup.py script for the following reasons:

  • We discouraged it already in issue Doc: Remove recommendation of "setup.py test" in Contribute Section  #148, so the script should not offer something that isn't advertised in our documentation.
  • According to Ionel Cristian Mărieș in "The setup script" section of his blog, he recommends a setup.py script should be "as simple as possible".
  • The less command logic we have, the better we can switch to other packaging tools if this would be needed in the future.

Maybe I miss a good reason, but at the moment, I think they are not really that essential, right?

Questions

  • Should we simplify the script? Is that be a feature we would like to have
  • If yes, for which version should we implement this?

@python-semver/reviewers What do you think about this proposal? 😉

@tomschr tomschr added Infra All about infrastructure (GitHub Action, project build etc.) Question Unclear or open issue subject for debate Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness labels Apr 13, 2020
tomschr added a commit to tomschr/python-semver that referenced this issue May 5, 2020
tomschr added a commit to tomschr/python-semver that referenced this issue May 14, 2020
@tomschr
Copy link
Member Author

tomschr commented Oct 19, 2020

This is covered in #290 so closing.

@tomschr tomschr closed this as completed Oct 19, 2020
@tomschr tomschr added the Release_3.x.y Only for the major release 3 label Oct 19, 2020
tlaferriere pushed a commit to tlaferriere/python-semver that referenced this issue Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness Infra All about infrastructure (GitHub Action, project build etc.) Question Unclear or open issue subject for debate Release_3.x.y Only for the major release 3
Projects
None yet
Development

No branches or pull requests

1 participant