diff --git a/README.md b/README.md index 999db50941a55f324f772d62b1ac7eb74cf23865..4a7c68caa0fd8f687d774b8c00e343387f4ca952 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Tikka -_The rich desktop Python client for Duniter Ğ1 crypto-currency_ +_The rich desktop Python client for Duniter V2 Ğ1 crypto-currency_ **Tikka** is a rich desktop Python client to manage your Ğ1 accounts. @@ -14,15 +14,39 @@ It is licenced under the [GPLv3 licence](https://www.gnu.org/licenses/gpl-3.0.en * [sqlite3](https://sqlite.org/index.html) database system via [sqlite3](https://docs.python.org/3/library/sqlite3.html) package * [Qt5](https://www.qt.io/) via [PyQt5](https://www.riverbankcomputing.com/software/pyqt/) package -## Install from PyPI +## Install with pipx -If you are in a virtual python environment: +You can use [pipx](https://pypa.github.io/pipx/installation/) to install Tikka. + + pipx install tikka + +Then simply run the `tikka` command: + + tikka + +Upgrade or uninstall: + + pipx upgrade tikka + + pipx uninstall tikka + +## Install/upgrade from PyPI + +If you are in a Python virtual environment: pip install --upgrade tikka If you are not: - pip install --user --upgrade tikka + # GNU/Linux virtualenv creation + mkdir tikka + cd tikka + python -m venv .venv + source .venv/bin/activate + pip install --upgrade tikka + + # get the path of the tikka command + which tikka ## Run from PyPI installation @@ -36,10 +60,13 @@ GNU/Linux system requirements: sudo apt-get install libsodium23 gcc +Depending on distribution, you will also need `libqt5multimedia5` or `libqt5multimediaquick5` lib. + + ## Development It is recommended to install and use [pyenv](https://github.com/pyenv/pyenv#installation) to install -the required python version. +the required Python version. For Pyinstaller, you need to install Python compiled with the --enable-shared option: @@ -54,10 +81,10 @@ Tikka internationalization requires gettext to be installed to generate locales Install [poetry](https://python-poetry.org/docs/#installation) -At this step, it is highly recommended to setup a virtual environment to isolate python dependencies of the project from the system and avoid conflicts. +At this step, it is highly recommended to setup a virtual environment to isolate Python dependencies of the project from the system and avoid conflicts. Use [poetry to manage the virtual environment](https://python-poetry.org/docs/managing-environments/). -Install all python dependencies with `poetry`: +Install all Python dependencies with `poetry`: poetry install --no-root @@ -141,7 +168,7 @@ Zip package will be created in `dist` folder: dist/tikka-0.1.0.zip -If Pyinstaller do not find the libpython libraries of pyenv, try to set the LD_LIBRARY_PATH env variable with the pyenv lib path: +If Pyinstaller do not find the `libpython` libraries of `pyenv`, try to set the `LD_LIBRARY_PATH` env variable with the `pyenv` lib path: Example: @@ -149,7 +176,7 @@ Example: ### CI/CD -Install gitlab-runner to test .gitlab-ci.yml. +Install `gitlab-runner` to test .gitlab-ci.yml. To test on a local docker image, specify pull policy: