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

Add explanation on Python package installation process #75

Open
1 task
mcdonnnj opened this issue Apr 18, 2022 · 0 comments
Open
1 task

Add explanation on Python package installation process #75

mcdonnnj opened this issue Apr 18, 2022 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@mcdonnnj
Copy link
Member

mcdonnnj commented Apr 18, 2022

💡 Summary

We should add to the development guide an explanation for why for Python package installation steps we typically lead with

python -m pip install --upgrade pip setuptools wheel

before installing other packages.

Motivation and context

We perform this step in most of our processes because of the need to upgrade pip and have wheel available. However, there is no explanation anywhere for why this is the case. We should document this here so that we have the rationale for this "on the record".

Implementation notes

Suitably explain why we upgrade pip and why we ensure setuptools and wheel are installed before proceeding with installing the Python packages actually required.

Acceptance criteria

  • An approved pull request adding such documentation is approved and merged.

Original conversation

Is there a reason we can't/shouldn't consolidate this into a single line?

          python -m pip install --upgrade build pip setuptools wheel

Originally posted by @dav3r in cisagov/skeleton-python-library#95 (comment)

@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

No branches or pull requests

1 participant