49 lines
1.1 KiB
ReStructuredText
49 lines
1.1 KiB
ReStructuredText
Installation
|
|
============
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- Python 3.11 or later
|
|
- ``sqlite3`` (if sqlite-backends are used)
|
|
|
|
Installing from PyPI
|
|
---------------------
|
|
|
|
The service is available on PyPI and can be installed with ``pip``:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install dump-things-service
|
|
|
|
Installing for Development
|
|
---------------------------
|
|
|
|
Clone the repository and install the package with all development dependencies
|
|
using `hatch <https://hatch.pypa.io/>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://codeberg.org/datalink/dump-things-server.git
|
|
cd dump-things-server
|
|
pip install hatch
|
|
hatch env create
|
|
|
|
Building the Documentation
|
|
---------------------------
|
|
|
|
The documentation dependencies are declared in the ``docs`` optional-dependency
|
|
group. To install them and build the HTML documentation:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install "dump-things-service[docs]"
|
|
make -C docs html
|
|
|
|
Alternatively, if you are using ``hatch`` execute the following command from the project root:
|
|
|
|
.. code-block:: bash
|
|
|
|
hatch run docs:build
|
|
|
|
The generated HTML will be placed in ``docs/_build/html/``.
|