Skip to content

docs: point install at the repo — envars2 is not on PyPI #19

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.

Sign up for GitHub

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

Closed
kthhrv wants to merge 1 commit into from
Closed

docs: point install at the repo — envars2 is not on PyPI #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Envars: Application Config as Code

[![PyPI version](https://badge.fury.io/py/envars2.svg)](https://badge.fury.io/py/envars2)
[![Documentation Status](https://readthedocs.org/projects/envars/badge/?version=latest)](https://envars.readthedocs.io/en/latest/?badge=latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Expand All @@ -24,7 +23,7 @@ Stop juggling `.env` files and start treating your configuration like code.
## Installation

```bash
pip install envars
pip install git+https://github.com/timeoutdigital/envars2.git

@gemini-code-assist gemini-code-assist Bot Aug 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
pip install git+https://github.com/timeoutdigital/envars2.git
pip install "envars @ git+https://github.com/timeoutdigital/envars2.git"

```

## Quick Start
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This tutorial will guide you through the basics of using `envars` to manage your
First, install `envars` using `pip`:

```bash
pip install envars
pip install git+https://github.com/timeoutdigital/envars2.git

@gemini-code-assist gemini-code-assist Bot Aug 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
pip install git+https://github.com/timeoutdigital/envars2.git
pip install "envars @ git+https://github.com/timeoutdigital/envars2.git"

```

## 2. Initialize Your Project
Expand Down