From 28f66849508789ac2619e5085493db68eb3561d2 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Tue, 14 Oct 2025 11:40:17 +0200 Subject: [PATCH 1/3] docs: :memo: add installation guide --- docs/guide/installation.qmd | 80 +++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 docs/guide/installation.qmd diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd new file mode 100644 index 00000000..33d9dc19 --- /dev/null +++ b/docs/guide/installation.qmd @@ -0,0 +1,80 @@ +--- +title: "Installing" +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. + +To check that these programs are installed, run the following commands +in your Terminal: + +``` {.bash filename="Terminal"} +python3 --version +pipx --version +``` + +If Python and pipx 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) + +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 +[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 +``` + +You can now install `check-datapackage` directly from the [GitHub +repository](https://github.com/seedcase-project/check-datapackage): + +``` {.bash filename="Terminal"} +uv add check-datapackage +``` + +You can check that `check-datapackage` has been installed correctly by +running this command: + +``` {.bash filename="Terminal"} +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, 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 d26eac2ab71eaa44bf45e1346a012dd8d7fb11c0 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Wed, 15 Oct 2025 11:10:06 +0200 Subject: [PATCH 2/3] docs: :pencil2: small 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 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index 33d9dc19..eecc5b91 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -5,7 +5,6 @@ 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. To check that these programs are installed, run the following commands @@ -42,7 +41,8 @@ To check that uv is installed, run this command: uv ``` -You can now install `check-datapackage` directly from the [GitHub +If you get a list of uv commands, you've installed it successfully. +With uv installed, you can now install `check-datapackage` directly from the [GitHub repository](https://github.com/seedcase-project/check-datapackage): ``` {.bash filename="Terminal"} From 2535d64bcb75b1a3d855e2b152daea004e0160c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 15 Oct 2025 12:27:32 +0200 Subject: [PATCH 3/3] style: :art: format `qmd` --- docs/guide/installation.qmd | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/guide/installation.qmd b/docs/guide/installation.qmd index eecc5b91..a256a4bd 100644 --- a/docs/guide/installation.qmd +++ b/docs/guide/installation.qmd @@ -41,8 +41,9 @@ To check that uv is installed, run this command: uv ``` -If you get a list of uv commands, you've installed it successfully. -With uv installed, you can now install `check-datapackage` directly from the [GitHub +If you get a list of uv commands, you've installed it successfully. With +uv installed, you can now install `check-datapackage` directly from the +[GitHub repository](https://github.com/seedcase-project/check-datapackage): ``` {.bash filename="Terminal"}