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.