docs: point install at the repo — envars2 is not on PyPI - #19
Conversation
'pip install envars' installs an unrelated third-party package (envars 0.3.5 from PyPI); this project is not published there, so the PyPI badge 404s too. Point install at the GitHub repo and drop the badge until the package is actually published. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the installation instructions in README.md and docs/getting-started.md to install the package directly from the GitHub repository instead of PyPI. The review feedback suggests using the explicit PEP 508 direct reference syntax (pip install "envars @ git+...") to avoid ambiguity and assist the dependency resolver, since the package name (envars) differs from the repository name (envars2).
|
|
||
| ```bash | ||
| pip install envars | ||
| pip install git+https://github.com/timeoutdigital/envars2.git |
There was a problem hiding this comment.
Since the package name (envars) differs from the repository name (envars2), it is recommended to use the explicit PEP 508 direct reference syntax. This makes it clear to pip and the user which package is being installed, and helps the dependency resolver.
| pip install git+https://github.com/timeoutdigital/envars2.git | |
| pip install "envars @ git+https://github.com/timeoutdigital/envars2.git" |
|
|
||
| ```bash | ||
| pip install envars | ||
| pip install git+https://github.com/timeoutdigital/envars2.git |
There was a problem hiding this comment.
Since the package name (envars) differs from the repository name (envars2), using the explicit PEP 508 direct reference syntax is recommended to avoid ambiguity for pip and the user.
| pip install git+https://github.com/timeoutdigital/envars2.git | |
| pip install "envars @ git+https://github.com/timeoutdigital/envars2.git" |
There was a problem hiding this comment.
Pull request overview
Updates installation guidance to avoid pip install envars pulling an unrelated third-party PyPI project, aligning docs with the fact that this repository’s package is not currently published on PyPI.
Changes:
- Removed the broken PyPI badge from
README.md. - Updated install instructions in
README.mdanddocs/getting-started.mdto install from the GitHub repository URL.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Removes PyPI badge and updates installation command to install from GitHub. |
| docs/getting-started.md | Updates getting-started installation command to install from GitHub. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ```bash | ||
| pip install envars | ||
| pip install git+https://github.com/timeoutdigital/envars2.git |
|
|
||
| ```bash | ||
| pip install envars | ||
| pip install git+https://github.com/timeoutdigital/envars2.git |
pip install envarscurrently installs an unrelated third-party package (envars 0.3.5, a different project) because this package isn't published on PyPI — and the README's PyPI badge 404s for the same reason.docs/getting-started.mdnow install viapip install git+https://github.com/timeoutdigital/envars2.gitenvarsname is taken on PyPI, so publishing needs a rename or theenvars2name the badge already pointed at)