From e4f53615aa11241a9fe58ae8cd6387d1c480660d Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Mon, 17 Nov 2025 12:12:07 +0100 Subject: [PATCH 1/5] docs: :memo: simplify install guide, only project-level install --- docs/guide/installation.qmd | 71 +++++++------------------------------ 1 file changed, 12 insertions(+), 59 deletions(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index 3d0c351f..dc2adb71 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -1,64 +1,37 @@ --- -title: "Installing `check-datapackage`" +title: "Installing" +description: "Steps to install `check-datapackage` in a Python project." order: 0 --- Before installing `check-datapackage`, you need to have [Python](https://www.python.org/downloads/) and -[pipx](https://pipx.pypa.io/latest/installation/) installed. +[uv](https://docs.astral.sh/uv/) installed. To check that these programs are installed, run the following commands in your Terminal: ``` {.bash filename="Terminal"} python3 --version -pipx --version +uv --version ``` -If Python and pipx are installed, these commands will show you the +If Python and uv are installed, these commands will show you the versions installed on your system. If you get an error, you need to install them before continuing. -## Install in a project (recommended) +## Install it in a Python project It's generally recommended to install Python packages in a project's virtual environment to keep the project's dependencies isolated from the -system-wide Python setup and avoid conflicts. There are several tools to -manage package dependencies and create virtual environments, such as -venv, virtualenv, and uv. For this guide, we will use +system-wide Python setup and avoid conflicts. We use (and recommend) [uv](https://docs.astral.sh/uv/). -If you don't have uv installed, you can install it in your Terminal with -pipx: - -``` {.bash filename="Terminal"} -pipx install uv -``` - -To check that uv is installed, run this command: - -``` {.bash filename="Terminal"} -uv -``` - -If you get a list of uv commands, you've installed it successfully. - -Then, create a Python project using uv by running the following command -in your Terminal (replace `` with your desired project -name, e.g., `diabetes-study`): - -``` {.bash filename="Terminal"} -uv init -``` - -This will create a new directory with the project name you provided with -the basic structure of a Python project, including a `pyproject.toml` -file. - -With uv installed, you can now install `check-datapackage` directly from -the [GitHub -repository](https://github.com/seedcase-project/check-datapackage) with -this command: +We assume you've already created a Python project that has a +`pyproject.toml` file. If not, review uv's guide on making +[projects](https://docs.astral.sh/uv/guides/projects/). While in the +Terminal and in the project's directoyr, add `check-datapackage` to your +project's virtual environment by running: ``` {.bash filename="Terminal"} uv add "check-datapackage @ git+https://github.com/seedcase-project/check-datapackage" @@ -75,23 +48,3 @@ uv pip show check-datapackage If `check-datapackage` has been installed successfully, the output will show details about `check-datapackage`. - -## Install system-wide - -We strongly recommend using `check-datapackage` in a virtual environment -(as described in the section above), but you can also install it -system-wide. The easiest way to do that is to use pipx: - -``` {.bash filename="Terminal"} -pipx install check-datapackage -``` - -To check that `check-datapackage` has been installed correctly, run the -following and make sure `check-datapackage` is listed: - -``` {.bash filename="Terminal"} -pipx list -``` - -Now you can use `check-datapackage` in any Python script on your -computer. From fca7e8989de18597e58b3451d9f975c82dff7c9f Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Tue, 18 Nov 2025 09:01:56 +0100 Subject: [PATCH 2/5] docs: :pencil2: some minor edits from review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Signe Kirk Brødbæk --- docs/guide/installation.qmd | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index dc2adb71..3c22f942 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -20,7 +20,7 @@ If Python and uv are installed, these commands will show you the versions installed on your system. If you get an error, you need to install them before continuing. -## Install it in a Python project +## Install `check-datapackage` in a Python project It's generally recommended to install Python packages in a project's virtual environment to keep the project's dependencies isolated from the @@ -29,8 +29,10 @@ system-wide Python setup and avoid conflicts. We use (and recommend) We assume you've already created a Python project that has a `pyproject.toml` file. If not, review uv's guide on making -[projects](https://docs.astral.sh/uv/guides/projects/). While in the -Terminal and in the project's directoyr, add `check-datapackage` to your +[projects](https://docs.astral.sh/uv/guides/projects/). + +While in the +Terminal and in the project's directory, add `check-datapackage` to your project's virtual environment by running: ``` {.bash filename="Terminal"} From 2e2a09dd0fb02a0405255dd264416716c16bc8a2 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 18 Nov 2025 08:03:21 +0000 Subject: [PATCH 3/5] chore(pre-commit): :pencil2: automatic fixes --- docs/guide/installation.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index 3c22f942..42b44697 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -29,7 +29,7 @@ system-wide Python setup and avoid conflicts. We use (and recommend) We assume you've already created a Python project that has a `pyproject.toml` file. If not, review uv's guide on making -[projects](https://docs.astral.sh/uv/guides/projects/). +[projects](https://docs.astral.sh/uv/guides/projects/). While in the Terminal and in the project's directory, add `check-datapackage` to your From bc0da5555e5641cf9cce1e0609489f0cf4da2cbb Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Tue, 18 Nov 2025 09:03:51 +0100 Subject: [PATCH 4/5] style: :art: format Markdown --- docs/guide/installation.qmd | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index 3c22f942..8a42413f 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -29,11 +29,10 @@ system-wide Python setup and avoid conflicts. We use (and recommend) We assume you've already created a Python project that has a `pyproject.toml` file. If not, review uv's guide on making -[projects](https://docs.astral.sh/uv/guides/projects/). +[projects](https://docs.astral.sh/uv/guides/projects/). -While in the -Terminal and in the project's directory, add `check-datapackage` to your -project's virtual environment by running: +While in the Terminal and in the project's directory, add +`check-datapackage` to your project's virtual environment by running: ``` {.bash filename="Terminal"} uv add "check-datapackage @ git+https://github.com/seedcase-project/check-datapackage" From d65471f4e66ead03c0abbe824d2494548ac382eb Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Tue, 18 Nov 2025 09:20:51 +0100 Subject: [PATCH 5/5] docs: :memo: to match the (future) descriptions --- docs/guide/installation.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index 8a42413f..01742660 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -1,6 +1,6 @@ --- title: "Installing" -description: "Steps to install `check-datapackage` in a Python project." +description: "A succinct instruction on installing `check-datapackage` in a Python project." order: 0 ---