From e55b107dd514b50dd8516659efc42a2873654d9a Mon Sep 17 00:00:00 2001 From: Keith Harvey Date: Fri, 21 Aug 2026 12:23:10 +0100 Subject: [PATCH 1/2] docs - fix install instructions and drop broken PyPI badge --- README.md | 16 ++++++++++++---- docs/getting-started.md | 7 +++++-- docs/project/ARCHITECTURE.md | 2 +- docs/project/contributing.md | 12 ++++++------ 4 files changed, 24 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 083ddf2..d78d911 100644 --- a/README.md +++ b/README.md @@ -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) @@ -23,10 +22,19 @@ Stop juggling `.env` files and start treating your configuration like code. ## Installation +`envars` is not published to PyPI — install it from this repository. The +`envars` package on PyPI is an unrelated third-party project. + ```bash -pip install envars +# pinned to a release tag (recommended) +pip install "git+https://github.com/timeoutdigital/envars2@1.0.4" + +# or, to add it to a uv-managed project +uv add "envars @ git+https://github.com/timeoutdigital/envars2@1.0.4" ``` +Drop the `@1.0.4` to track `master`. Either form installs the `envars` command. + ## Quick Start 1. **Initialize a new project:** @@ -145,8 +153,8 @@ Here are some ideas for future enhancements that could make `envars` even more p To set up the development environment, clone the repository and install the dependencies using `uv`: ```bash -git clone https://github.com/your-username/envars.git -cd envars +git clone https://github.com/timeoutdigital/envars2.git +cd envars2 uv sync ``` diff --git a/docs/getting-started.md b/docs/getting-started.md index b989829..401a8f3 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,12 +4,15 @@ This tutorial will guide you through the basics of using `envars` to manage your ## 1. Installation -First, install `envars` using `pip`: +`envars` is not published to PyPI — install it from GitHub. (The `envars` +package on PyPI is an unrelated third-party project.) ```bash -pip install envars +pip install "git+https://github.com/timeoutdigital/envars2@1.0.4" ``` +Drop the `@1.0.4` to track `master`. + ## 2. Initialize Your Project The `envars init` command is the best way to start a new project. It creates the `envars.yml` file with the basic structure. diff --git a/docs/project/ARCHITECTURE.md b/docs/project/ARCHITECTURE.md index 6b416e9..7690f37 100644 --- a/docs/project/ARCHITECTURE.md +++ b/docs/project/ARCHITECTURE.md @@ -132,7 +132,7 @@ This guide will help new developers get up and running with the `envars2` projec 1. **Clone the repository:** ```bash - git clone https://github.com/your-username/envars2.git + git clone https://github.com/timeoutdigital/envars2.git cd envars2 ``` diff --git a/docs/project/contributing.md b/docs/project/contributing.md index 5f168df..0f18ce6 100644 --- a/docs/project/contributing.md +++ b/docs/project/contributing.md @@ -4,14 +4,14 @@ We welcome contributions from the community! Whether you're fixing a bug, improv ## Getting Started -1. **Fork the repository** on GitHub. -2. **Clone your fork** locally: `git clone https://github.com/your-username/envars.git` -3. **Install dependencies** for development. We use `uv` for package management. +1. **Clone the repository** locally: `git clone https://github.com/timeoutdigital/envars2.git` +2. **Install dependencies** for development. We use `uv` for package management. ```bash pip install uv uv sync ``` -4. **Create a new branch** for your changes: `git checkout -b my-feature-branch` +3. **Create a new branch** for your changes: `git checkout -b my-feature-branch` + (the `no-commit-to-branch` pre-commit hook blocks committing to `master`) ## Running Tests @@ -39,8 +39,8 @@ uv run pre-commit install ## Submitting a Pull Request 1. **Commit your changes** with a clear and descriptive commit message. -2. **Push your branch** to your fork on GitHub: `git push origin my-feature-branch` -3. **Open a pull request** from your branch to the `main` branch of the original repository. +2. **Push your branch** to GitHub: `git push origin my-feature-branch` +3. **Open a pull request** from your branch to `master`. 4. In the pull request description, please explain the changes you made and why. Thank you for contributing! From af6bcac5f1bd559bce3f07252786ef4350602b1e Mon Sep 17 00:00:00 2001 From: Keith Harvey Date: Fri, 21 Aug 2026 13:52:20 +0100 Subject: [PATCH 2/2] docs - PR review fixes - contributing.md: note that contributors without write access to timeoutdigital/envars2 must fork first, at both the clone and push steps. - README + getting-started: the unpinned install form tracks the repository's default branch, not the literal name "master". --- README.md | 3 ++- docs/getting-started.md | 3 ++- docs/project/contributing.md | 6 ++++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d78d911..07ac6a4 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,8 @@ pip install "git+https://github.com/timeoutdigital/envars2@1.0.4" uv add "envars @ git+https://github.com/timeoutdigital/envars2@1.0.4" ``` -Drop the `@1.0.4` to track `master`. Either form installs the `envars` command. +Drop the `@1.0.4` to install from the repository's default branch (currently +`master`). Either form installs the `envars` command. ## Quick Start diff --git a/docs/getting-started.md b/docs/getting-started.md index 401a8f3..717125e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -11,7 +11,8 @@ package on PyPI is an unrelated third-party project.) pip install "git+https://github.com/timeoutdigital/envars2@1.0.4" ``` -Drop the `@1.0.4` to track `master`. +Drop the `@1.0.4` to install from the repository's default branch (currently +`master`). ## 2. Initialize Your Project diff --git a/docs/project/contributing.md b/docs/project/contributing.md index 0f18ce6..dc98b18 100644 --- a/docs/project/contributing.md +++ b/docs/project/contributing.md @@ -5,6 +5,8 @@ We welcome contributions from the community! Whether you're fixing a bug, improv ## Getting Started 1. **Clone the repository** locally: `git clone https://github.com/timeoutdigital/envars2.git` + Without write access to `timeoutdigital/envars2` you cannot push a branch to it — + fork the repository on GitHub first and clone your fork instead. 2. **Install dependencies** for development. We use `uv` for package management. ```bash pip install uv @@ -39,8 +41,8 @@ uv run pre-commit install ## Submitting a Pull Request 1. **Commit your changes** with a clear and descriptive commit message. -2. **Push your branch** to GitHub: `git push origin my-feature-branch` -3. **Open a pull request** from your branch to `master`. +2. **Push your branch**: `git push origin my-feature-branch` — to your fork, if you cloned one. +3. **Open a pull request** from your branch to `master` on `timeoutdigital/envars2`. 4. In the pull request description, please explain the changes you made and why. Thank you for contributing!