path: root/README.md
diff options
Diffstat (limited to 'README.md')
1 files changed, 16 insertions, 10 deletions
diff --git a/README.md b/README.md
index 6c0978d..30c8e1b 100644
--- a/README.md
+++ b/README.md
@@ -10,21 +10,21 @@ The information below is meant to help hack on the codebase. If you're instead l
* Python3 (>= 3.7)
* [hydrilla.builder](https://git.koszko.org/hydrilla-builder/)
-* flask
+* flask (>= 1.1)
* click
* jsonschema (>= 3.0)
### Build
+* build (a PEP517 package builder)
* setuptools
* wheel
* setuptools_scm
-* babel
+* babel (Python library)
### Test
* pytest
-* reuse
## Building
@@ -46,15 +46,11 @@ Commands like `python3 -m build` and `python3 -m pip` but also `virtualenv` will
To perform the build and installation without PyPI, first install all dependencies system-wide. For example, in Debian-based distributions (including Trisquel):
``` shell
sudo apt install python3-flask python3-flask python3-jsonschema \
- python3-setuptools python3-setuptools-scm python3-babel python3-wheel
+ python3-setuptools python3-setuptools-scm python3-babel python3-wheel \
+ python3-build
-Then, block programs you're about to spawn from accessing https://pypi.org. If running on a GNU/Linux system you can utilize Linux user namespaces:
-``` shell
-unshare -Urn
-The above will put you in a network-isolated shell. If you're using a virtualenv, activate it **after** the `unshare` command.
+If you're using `virtualenv` command to create a virtual environment, make sure you invoke it with `--system-site-packages` and `--no-download`. The first option is necessary for packages installed inside the virtualenv to be able to use globally-installed dependencies. The second one will make `virtualenv` use locally-available base libraries (setuptools, etc.) instead of downloading them from PyPI.
Now, in unpacked source directories of **both** `hydrilla-builder` and `hydrilla`, run the build and installation commands:
``` shell
@@ -72,6 +68,16 @@ For tests to pass you need compiled message catalogs to be present. If you've pe
python3 -m pytest
+## Installation from wheels
+Instead of building yourself you can use Python wheels provided on [Hydrilla downloads page](https://hydrillabugs.koszko.org/projects/hydrilla/wiki/Releases).
+``` shell
+python3 -m pip install \
+ path/to/downloaded/hydrilla.builder-1.1b1-py3-none-any.whl \
+ path/to/downloaded/hydrilla-1.1b1-py3-none-any.whl
## Running
### Hydrilla command