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.

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

Update python commands in documentation #1349

Closed
KainaatSingh opened this issue Apr 14, 2021 · 5 comments
Closed

Update python commands in documentation #1349

KainaatSingh opened this issue Apr 14, 2021 · 5 comments
Assignees
Labels
documentation Documentation of the project as well as procedural documentation good first issue Bite-sized items for first time contributors

Comments

@KainaatSingh
Copy link
Contributor

Description of issue or feature request:
With the release of tuf 0.17.0 python2 support was removed. Parts of the documentations contain commands that state the usage of python instead of python3 and pip instead of pip3. The commands with "python" will not work outside the virtualenv. It would help to explicitly state "python3" and "pip3" here.

It would be helpful to agree on as to where and what changes might be appropriate.

Current behavior:
pip install -r requirement-dev.txt
python aggregate_tests.py

Expected behavior:
pip3 install -r requirements-dev.txt
python3 aggregate_tests.py

@jku
Copy link
Member

jku commented Apr 14, 2021

The commands with "python" will not work outside the virtualenv

This depends, it does work in some OSes / install methods... but consistency is good so I think this is a good idea.

python3 aggregate_tests.py looks obviously correct to me. https://docs.python.org/3/installing/index.html seems to suggest following would be best for pip calls: python3 -m pip install -r requirements-dev.txt.

@MVrachev MVrachev added the good first issue Bite-sized items for first time contributors label Apr 26, 2021
@sechkova sechkova added the documentation Documentation of the project as well as procedural documentation label May 18, 2021
@samuelgregorovic
Copy link
Contributor

samuelgregorovic commented Jun 24, 2021

i can update the docs to exclude old python2 commands and update them to python3, if you would assign it to me

@jku
Copy link
Member

jku commented Jun 28, 2021

Thank you, assigning

@samuelgregorovic
Copy link
Contributor

@jku i updated everything relevant i could find + removed some doc-lines where you could find Python2 command alternative. I also updated the pip install commands to be consistent to -> python3 -m pip install

samuelgregorovic added a commit to samuelgregorovic/tuf that referenced this issue Jul 9, 2021
@jku
Copy link
Member

jku commented Jul 14, 2021

Fixed in #1493, thanks!

@jku jku closed this as completed Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation of the project as well as procedural documentation good first issue Bite-sized items for first time contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants