diff options
| -rw-r--r-- | docs/contributor_guide/build_package.md | 36 | ||||
| -rw-r--r-- | docs/installation.md | 4 | ||||
| -rw-r--r-- | mkdocs.yml | 1 |
3 files changed, 39 insertions, 2 deletions
diff --git a/docs/contributor_guide/build_package.md b/docs/contributor_guide/build_package.md new file mode 100644 index 0000000..fae1730 --- /dev/null +++ b/docs/contributor_guide/build_package.md @@ -0,0 +1,36 @@ +Build package +============= + +ArGaze build system is based on [setuptools](https://setuptools.pypa.io/en/latest/userguide/index.html) and [setuptools-scm](https://setuptools-scm.readthedocs.io/en/latest/) to use Git tag as package version number. + +!!! note + + *Consider that all inline commands below have to be executed at the root of ArGaze Git repository.* + +Install or upgrade the required packages: + +```console +pip install build setuptools setuptools-scm +``` + +Commit last changes then, tag the Git repository with a VERSION that follows the [setuptools versionning schemes](https://setuptools.pypa.io/en/latest/userguide/distribution.html): + +```console +git tag -a VERSION -m "Version message" +``` + +Push commits and tags: + +```console +git push && git push --tags +``` + +Then, build package: +```console +python -m build +``` + +Once the build is done, two files are created in a *dist* folder: + +* **argaze-VERSION-py3-none-any.whl**: the built package (*none* means for no specific OS, *any* means for any architecture). +* **argaze-VERSION.tar.gz**: the source package. diff --git a/docs/installation.md b/docs/installation.md index 66b801b..fe4cfa4 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -37,8 +37,8 @@ pip install ./dist/argaze-VERSION.whl !!! note "As ArGaze package contributor" - *You should prefer to install the package in developer mode to test live code changes:* + *You should prefer to install the package in editable mode to test live code changes:* ``` - pip install -e . + pip install --editable . ``` @@ -73,6 +73,7 @@ nav: - Code Reference: - argaze.md - Contributor Guide: + - contributor_guide/build_package.md - contributor_guide/build_documentation.md - contributor_guide/unitary_test.md theme: |