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 step about upgrading pip in the venv to avoid errors when installing dependencies docs/en/docs/contributing.md #5181

Merged
merged 3 commits into from Aug 26, 2022

Conversation

edisnake
Copy link
Contributor

Doc improvement for avoiding issues when installing dependencies as contributor.

@codecov
Copy link

codecov bot commented Jul 20, 2022

Codecov Report

Merging #5181 (660829a) into master (d69b5f3) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master     #5181   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          535       535           
  Lines        13825     13825           
=========================================
  Hits         13825     13825           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions
Copy link
Contributor

📝 Docs preview for commit 91aca11 at: https://62d83863194b980600bb5976--fastapi.netlify.app

<div class="termy">

```console
$ python -m pip install --upgrade pip
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, this command helped me to solve errors when attempting to install Flit since I had and old pip version, .i.e.

$ python -m pip install --upgrade pip
Cache entry deserialization failed, entry ignored
Collecting pip
  Downloading https://files.pythonhosted.org/packages/a4/6d/6463d49a933f547439d6b5b98b46af8742cc03ae83543e4d7688c2420f8b/pip-21.3.1-py3-none-any.whl (1.7MB)
    100% |████████████████████████████████| 1.7MB 816kB/s 
Installing collected packages: pip
  Found existing installation: pip 9.0.1
    Uninstalling pip-9.0.1:
      Successfully uninstalled pip-9.0.1
Successfully installed pip-21.3.1

@edisnake
Copy link
Contributor Author

Hi @tiangolo please take a look when having a chance, thx!

@JarroVGIT
Copy link
Contributor

If you have a current version of Python, then pip wouldn't be outdated. What version did you have that Flit conflict with?

@edisnake
Copy link
Contributor Author

If you have a current version of Python, then pip wouldn't be outdated. What version did you have that Flit conflict with?

Python 3.6.9 which meets FastApi requirements as stated on the main page.
image

I believe it's important to add the proposed pip upgrade step since I've seen many developers (beginners to seniors) struggling with similar issues in different projects, but it's up to you guys!

@JarroVGIT
Copy link
Contributor

If you have a current version of Python, then pip wouldn't be outdated. What version did you have that Flit conflict with?

Python 3.6.9 which meets FastApi requirements as stated on the main page. image

I believe it's important to add the proposed pip upgrade step since I've seen many developers (beginners to seniors) struggling with similar issues in different projects, but it's up to you guys!

Agreed, this should work on Python 3.6.9, and if this makes sure it works for that supported version, I am all for it to include it in the docs! :)

Copy link
Contributor

@JarroVGIT JarroVGIT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tiangolo tiangolo changed the title Adding pip step to avoid errors when installing dependencies 📝 Add step about upgrading pip in the venv to avoid errors when installing dependencies docs/en/docs/contributing.md Aug 26, 2022
@tiangolo
Copy link
Owner

Nice thank you @edisnake! 🚀

And thanks @JarroVGIT for the discussion! ☕

@tiangolo tiangolo enabled auto-merge (squash) August 26, 2022 14:25
@tiangolo tiangolo merged commit b3f2f08 into tiangolo:master Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants