doc: installation instructions

Author: azmeuk

README.md

@@ -22,50 +22,19 @@ It allows users and groups creations, modifications and deletions to be synchron
 
 ## Installation
 
-### Binary files
-
-Binary files are available on the [releases page](https://github.com/python-scim/scim2-cli/releases).
-
-### Python package
-
-scim2-cli is published on the [PyPI repository](https://pypi.org/project/scim2-cli).
-You can install it with your favourite python package manager.
-
-```shell
-pip install scim2-cli
+```console
+$ curl -LsSf uvx.sh/scim2-cli/install.sh | sh
 ```
 
-### From sources
-
-To run scim2-cli from the sources, [uv is needed](https://docs.astral.sh/uv/getting-started/installation/) for development:
-
-```shell
-git clone https://github.com/python-scim/scim2-cli.git
-cd scim2-cli
-uv sync
-```
-
-Then, it can be launched directly as a Python script:
-
-```shell
-uv run scim2 --help
-```
-
-Or you can build a single file binary from the sources:
-
-```shell
-uv sync --group bundle
-uv run pyinstaller --name scim2 --onefile scim2_cli/__init__.py
-./dist/scim2 --help
-```
+Check the [installation documentation](https://scim2-cli.readthedocs.io/en/latest/installation.html) for other methods.
 
 ## Usage
 
 Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html) for more details.
 
 Here is an example of resource creation:
 
-```shell
+```console
 $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" create user --user-name "bjensen@example.com"
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
@@ -83,7 +52,7 @@ $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" create
 
 Here is an example of resource query:
 
-```shell
+```console
 $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" query user 2819c223-7f76-453a-919d-413861904646
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],

doc/conf.py

@@ -17,7 +17,10 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_click",
+    "sphinx_design",
+    "sphinx_iconify",
     "sphinx_issues",
+    "sphinx_substitution_extensions",
 ]
 
 templates_path = ["_templates"]
@@ -34,6 +37,11 @@
 
 version = metadata.version("scim2_cli")
 language = "en"
+
+rst_prolog = f"""
+.. |version| replace:: {version}
+"""
+
 pygments_style = "sphinx"
 todo_include_todos = True
 toctree_collapse = False

doc/index.rst

@@ -7,6 +7,7 @@ Table of contents
 .. toctree::
     :maxdepth: 2
 
+    installation
     tutorial
     reference
     contributing

doc/installation.rst

@@ -0,0 +1,95 @@
+Installation
+============
+
+.. tab-set::
+
+   .. tab-item:: :iconify:`material-icon-theme:uv` uvx.sh
+      :sync: uvx-sh
+
+      `uvx.sh <https://uvx.sh>`_ provides an installation script that installs scim2-cli permanently on your system.
+
+      .. tab-set::
+         :class: outline
+
+         .. tab-item:: Linux / macOS
+
+            .. code-block:: console
+
+               $ curl -LsSf uvx.sh/scim2-cli/install.sh | sh
+
+         .. tab-item:: Windows
+
+            .. code-block:: powershell
+
+               powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/scim2-cli/install.ps1 | iex"
+
+      Then you can run:
+
+      .. code-block:: console
+
+         $ scim2 --help
+
+   .. tab-item:: :iconify:`material-icon-theme:uv` uvx
+      :sync: uvx
+
+      If you have `uv`__ installed, you can run scim2-cli directly without installing it:
+
+      __ https://docs.astral.sh/uv/
+
+      .. code-block:: console
+
+         $ uvx scim2-cli --help
+
+   .. tab-item:: :iconify:`devicon:pypi` pip
+      :sync: pip
+
+      scim2-cli is published on `PyPI <https://pypi.org/project/scim2-cli>`_.
+
+      .. code-block:: console
+
+         $ pip install scim2-cli
+
+      Then you can run:
+
+      .. code-block:: console
+
+         $ scim2 --help
+
+   .. tab-item:: :iconify:`mdi:file-download` Binaries
+      :sync: binaries
+
+      Binary files are available on the `releases page <https://github.com/python-scim/scim2-cli/releases>`_.
+
+      .. code-block:: console
+         :substitutions:
+
+         $ wget https://github.com/python-scim/scim2-cli/releases/download/|version|/scim2-linux -O scim2
+         $ chmod +x scim2
+         $ ./scim2 --help
+
+   .. tab-item:: :iconify:`devicon:git` Sources
+      :sync: sources
+
+      To run scim2-cli from the sources, `uv`__ is needed:
+
+      __ https://docs.astral.sh/uv/getting-started/installation/
+
+      .. code-block:: console
+
+         $ git clone https://github.com/python-scim/scim2-cli.git
+         $ cd scim2-cli
+         $ uv sync
+
+      Then you can run it directly:
+
+      .. code-block:: console
+
+         $ uv run scim2 --help
+
+      Or build a single file binary:
+
+      .. code-block:: console
+
+         $ uv sync --group bundle
+         $ uv run pyinstaller --name scim2 --onefile scim2_cli/__init__.py
+         $ ./dist/scim2 --help

pyproject.toml

@@ -51,11 +51,14 @@ dev = [
     "tox-uv>=1.16.0",
 ]
 doc = [
+    "myst-parser>=3.0.1",
     "shibuya>=2024.5.15",
     "sphinx>=7.3.7",
     "sphinx-click>=6.0.0",
-    "sphinx-issues >= 5.0.0",
-    "myst-parser>=3.0.1",
+    "sphinx-design>=0.6.0",
+    "sphinx-iconify>=0.0.6",
+    "sphinx-issues>=5.0.0",
+    "sphinx-substitution-extensions>=2024.8.6",
 ]
 bundle = [
     "pyinstaller>=6.10.0",