diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/installation.rst | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/doc/administration/installation.rst b/doc/administration/installation.rst index 1b5d620..53734b5 100644 --- a/doc/administration/installation.rst +++ b/doc/administration/installation.rst @@ -9,12 +9,24 @@ Requirements Fietsboek has the following requirements (apart from the Python modules, which will be installed by ``pip``): -* Python 3.7 or later +* Python 3.9 or later * A `redis <https://redis.com/>`__ server, used for caching and temporary data * (Optionally) an SQL database server like `PostgreSQL <https://www.postgresql.org/>`__ or `MariaDB <https://mariadb.org/>`__ (if SQLite is not enough) +In addition, if you run on a different interpreter than CPython, you might need +a working Rust toolchain (``rustc`` and ``cargo``) installed. This is because +some of Fietsboek's dependencies (such as ``pydantic`` and ``nh3``) use Rust +modules. If they don't provide a binary wheel for your interpreter, they will +automatically build one during the installation process — but that requires the +Rust toolchain. + +To install Rust, check out your distributions wiki/packages, or use the `rustup +tool`_. + +.. _rustup tool: https://rustup.rs/ + Creating an Environment ----------------------- @@ -54,6 +66,13 @@ process the GPX files: .venv/bin/pip install lxml +.. note:: + + It is currently unclear whether ``lxml`` does provide a speed benefit over + the alternative, especially when running on PyPy. See also `issue #7`_. + + .. _issue #7: https://gitlab.com/dunj3/fietsboek/-/issues/7 + Configuring Fietsboek --------------------- |