Merge pull request #10 from yaal-coop/binaries

doc: binary building

Author: azmeuk

.github/workflows/release.yml

@@ -44,7 +44,6 @@ jobs:
         python-version: 3.12
     - run: pip install poetry
     - run: poetry install
-    - run: poetry run pip install pyinstaller
     - run: poetry run pyinstaller --name scim2-${{ matrix.os }} --onefile scim2_cli/__init__.py
     - run: ./dist/scim2-${{ matrix.os }}
     - uses: actions/upload-artifact@v4

README.md

@@ -11,11 +11,41 @@ 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/yaal-coop/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
 ```
 
-Binary files are also available on the [releases page](https://github.com/yaal-coop/scim2-cli/releases).
+### From sources
+
+To run scim2-cli from the sources, [Poetry is needed](https://python-poetry.org/docs/#installation) for development:
+
+```shell
+git clone https://github.com/yaal-coop/scim2-cli.git
+cd scim2-cli
+poetry install
+```
+
+Then, it can be launched directly as a Python script:
+
+```shell
+poetry run scim2 --help
+```
+
+Or you can build a single file binary from the sources:
+
+```shell
+poetry run pyinstaller --name scim2 --onefile scim2_cli/__init__.py
+./dist/scim2 --help
+```
 
 ## Usage
 

poetry.lock

@@ -29,21 +29,22 @@ changelog = "https://scim2-cli.readthedocs.io/en/latest/changelog.html"
 funding = "https://github.com/sponsors/yaal-coop"
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = ">=3.10,<3.14"
 click = "^8.1.7"
 scim2-client = "^0.2.0"
 scim2-tester = "^0.1.3"
 sphinx-click-rst-to-ansi-formatter = "^0.1.0"
 pydanclick = "^0.3.0"
 
-[tool.poetry.group.doc]
-optional = true
-
 [tool.poetry.group.dev.dependencies]
+pyinstaller = "^6.10.0"
 pytest = "^8.2.1"
 pytest-coverage = "^0.0"
 pytest-httpserver = "^1.0.10"
 
+[tool.poetry.group.doc]
+optional = true
+
 [tool.poetry.group.doc.dependencies]
 shibuya = "^2024.5.15"
 sphinx = "^7.3.7"
@@ -101,6 +102,7 @@ envlist =
     py312
     doc
     coverage
+    binaries
 
 [testenv]
 allowlist_externals = poetry
@@ -124,4 +126,9 @@ commands =
     poetry install
     poetry run pytest --cov --cov-fail-under=100 --cov-report term:skip-covered {posargs}
     poetry run coverage html
+
+[testenv:binaries]
+commands =
+    poetry install
+    poetry run pyinstaller --name scim2 --onefile scim2_cli/__init__.py
 """