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 pip commands to install 1.10 #6930

Merged
merged 5 commits into from Jul 28, 2023

Conversation

chbndrhnns
Copy link
Contributor

@chbndrhnns chbndrhnns commented Jul 28, 2023

Change Summary

The installation instructions are incomplete for v1:

  • the pip command installs v2
  • pdm is not mentioned as a dependency
  • the links to the Github repo should be git+https, not git+git

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @hramezani

@chbndrhnns chbndrhnns force-pushed the fix-docs branch 3 times, most recently from f01260b to 71f9a9d Compare July 28, 2023 13:51
@chbndrhnns
Copy link
Contributor Author

please review

@@ -33,7 +33,7 @@ To make contributing as easy and fast as possible, you'll want to run tests and
*pydantic* has few dependencies, doesn't require compiling and tests don't need access to databases, etc.
Because of this, setting up and running the tests should be very simple.

You'll need to have a version between **Python 3.7 and 3.11**, **virtualenv**, **git**, and **make** installed.
You'll need to have a version between **Python 3.7 and 3.11**, **virtualenv**, **git**, **pdm** and **make** installed.
Copy link
Member

Choose a reason for hiding this comment

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

I think we don't have pdm in V1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

make install failed without pdm being installed so I added it. Do you still want me to remove it?

Copy link
Member

Choose a reason for hiding this comment

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

You are right. Sorry!

@hramezani
Copy link
Member

Thanks @chbndrhnns 🙏

Just left a small comment. Other than that LGTM

please update

@hramezani hramezani merged commit 87bf417 into pydantic:1.10.X-fixes Jul 28, 2023
49 checks passed
@chbndrhnns chbndrhnns deleted the fix-docs branch July 28, 2023 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants