@@ -11,6 +11,7 @@ Developed in support of the [Kolibri](https://github.com/learningequality/kolibr
1111- A certificate-based authentication system to protect privacy and integrity of data
1212- A change-tracking system to support calculation of differences between databases across low-bandwidth connections
1313- A set of constructs to support data partitioning
14+ - Support for SQLite and PostgreSQL
1415
1516## Developer documentation
1617
@@ -20,29 +21,36 @@ See [morango.readthedocs.io](https://morango.readthedocs.io) for documentation o
2021
2122To start contributing to Morango, first make sure you [ have ` uv ` installed] ( https://docs.astral.sh/uv/getting-started/installation/ ) .
2223
23- Create a virtual environment, with at least python 3.9 :
24+ Create a virtual environment, which will create it in the ` .venv/ ` directory, with the python version defined in ` .python-version ` :
2425``` bash
25- uv venv -p 3.10
26+ uv venv
2627```
2728
2829Then install dependencies:
2930``` bash
3031uv sync --all-extras
3132```
3233
33- If you get during installation, you may need to install system packages such as ` openssl ` and ` libssl-dev ` .
34+ If you get errors during installation, you may need to install system packages such as ` openssl ` and ` libssl-dev ` .
3435
3536Finally, set up pre-commit hooks:
3637``` bash
3738prek install # with -f to reinstall
3839```
3940
41+ ### Building
42+ Building the project is as easy as:
43+ ``` bash
44+ uv build
45+ ```
46+ Afterwards, you'll find a source archive and wheel file in ` dist/ ` .
47+
4048### Docs
4149
4250To build and edit the docs, run:
4351
4452``` bash
45- # install requirements
53+ # install requirements (if necessary)
4654uv sync --extra docs
4755
4856# build docs
0 commit comments