Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs that mention setup.py need checking/updating #536

Open
abravalheri opened this issue Oct 30, 2021 · 3 comments
Open

Docs that mention setup.py need checking/updating #536

abravalheri opened this issue Oct 30, 2021 · 3 comments
Labels
documentation Improvements, additions and corrections to documentation good first issue Good for newcomers help wanted Extra attention is needed and contributors are encouraged to participate

Comments

@abravalheri
Copy link
Collaborator

Description of your problem

Recently I noticed our docs still mention a lot of direct execution of setup.py, and that is now deprecated (see #535 for other details).

It would be nice to go through the docs and make sure these mentions are removed.

There are also a lot of complexity for making sure we show alternative commands when the person do not want to use tox.
That is definetely going to be removed in the next version of PyScaffold, together with the --no-tox extension. But maybe the docs can also be simplified right now? (e.g. using a disclaimer in the top of the file saying something like: "if you don't use tox, see this link for alternatives")
@abravalheri abravalheri added help wanted Extra attention is needed and contributors are encouraged to participate documentation Improvements, additions and corrections to documentation good first issue Good for newcomers labels Oct 30, 2021
@FlorianWilhelm
Copy link
Member

BTW, what's the best way to do python setup.py --version now without using setup.py?

@abravalheri
Copy link
Collaborator Author

Unfortunately there is no official answer for that yet.

Some time ago I proposed a change in setuptools-scm to address this use case, and initially it was well received by the maintainers.

But I guess they did not have the chance yet/bandwidth to go through the review process :(

@abravalheri
Copy link
Collaborator Author

Just an update on this topic: setuptools-scm has accepted the PR, now we just need to wait until they release a new version :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements, additions and corrections to documentation good first issue Good for newcomers help wanted Extra attention is needed and contributors are encouraged to participate
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@abravalheri @FlorianWilhelm