* General tips : use pyenv to build sakia, as described in the [wiki](https://github.com/duniter/sakia/wiki/Cutecoin-install-for-developpers)
General tips : use [pyenv](https://github.com/pyenv/pyenv) to build sakia, as described in the [documentation](https://git.duniter.org/clients/python/sakia/-/blob/master/doc/install_for_developers.md)
Building Python with pyenv requires libraries of `openssl` and `sqlite3`. On Ubuntu, install it using the following commands :
Building python 3 with pyenv requires libraries of `openssl` and `sqlite3`. On Ubuntu, install it using the following commands :
```
apt-get update
apt-get update
apt-get install libssl-dev
apt-get install libssl-dev
apt-get install libsqlite3-dev
apt-get install libsqlite3-dev
```
### Wheel Build scripts
* Install __wheel__ with `pip install wheel`
* Run `python3 gen_resources.py` in sakia folder
* Run `python3 gen_translations.py` in sakia folder
* To build the wheel : Run `python3 setup.py bdist_wheel` in sakia folder
### Pyinstaller Build scripts
* Install __pyinstaller__ with `pip install pyinstaller`
* Run `python3 gen_resources.py` in sakia folder
* Run `python3 gen_translations.py` in sakia folder
* To build the binaries : Run `pyinstall sakia.spec`
### Install with pip
### Install with pip
* Run `pip install sakia`
* Run `pip install sakia`
* start "sakia" :)
* start "sakia" :)
### Download latest release
### Download latest release
* Go to [current release](https://github.com/duniter/sakia/releases)
* Go to [current release](https://git.duniter.org/clients/python/sakia/-/releases)
* Download corresponding package to your operating system
* Download AppImage for linux x86_64. Run it !
* Unzip and start "sakia" :)
* Join our developer community by contacting us on [duniter forum](http://forum.duniter.org/)
* Join our beta community by contacting us on [duniter forum](http://forum.duniter.org/)
`--currency g1-test` to connect to the g1-test currency network.
`--currency g1-test` to connect to the g1-test currency network.
## Development
## Development
* When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
* When writing docstrings, use the reStructuredText format recommended by [PEP 0287](https://www.python.org/dev/peps/pep-0287/#docstring-significant-features)
* Use make commands to check the code and the format it correct.
* Use make commands to check the code and the format it correct.
The development tools require Python 3.6.x or higher.
The development tools require Python 3.6.x or higher.
*Create a python virtual environment with [pyenv](https://github.com/pyenv/pyenv)
*Install a supported Python version with [pyenv](https://github.com/pyenv/pyenv)
* Before submiting a merge requests, please check the static typing and tests.
* Before submiting a merge requests, please check the static typing and tests.
* Install dev dependencies
* Install dev dependencies
```bash
pip install -r requirements_dev.txt
pip install -r requirements_dev.txt
```
* Check static typing with [mypy](http://mypy-lang.org/)
* Check static typing with [mypy](http://mypy-lang.org/)
```bash
make check
make check
```
* Run all unit tests (pytest module) with:
* Run all unit tests (pytest module) with:
```bash
make tests
make tests
```
> **Warning:** *do not run tests with sakia installed in your dev environment, because pytest will use the installed Sakia.*
> **Warning:** *do not run tests with sakia installed in your dev environment, because pytest will use the installed Sakia.*
* Run only some unit tests by passing a special ENV variable:
* Run only some unit tests by passing a special ENV variable:
```bash
make tests TESTS_FILTER=tests/functional/test_transfer_dialog.py::test_transfer
make tests TESTS_FILTER=tests/functional/test_transfer_dialog.py::test_transfer
```
## Packaging and deploy
## Packaging and deploy
### PyPi
### PyPi
In the development pyenv environment, install the tools to build and deploy
In the development pyenv environment, install the tools to build and deploy
```bash
pip install --upgrade -r requirements_deploy.txt
pip install --upgrade -r requirements_deploy.txt
```
Change and commit and tag the new version number (semantic version number)
Change and commit and tag the new version number (semantic version number)
```bash
./release.sh 0.x.y
./release.sh 0.x.y
```
Build the PyPi package in the `dist` folder
Build the PyPi package in the `dist` folder
```bash
make build
make build
```
Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
Deploy the package on the PyPi repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
Deploy the package on the PyPi repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
