Skip to content

Commit 80a3f26

Browse files
committed
Migrate to prek for pre-commit hooks, and add docs
1 parent b9933f6 commit 80a3f26

3 files changed

Lines changed: 52 additions & 4 deletions

File tree

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,36 @@ Developed in support of the [Kolibri](https://github.com/learningequality/kolibr
1414

1515
## Developer documentation
1616

17-
See [morango.readthedocs.io](https://morango.readthedocs.io)
17+
See [morango.readthedocs.io](https://morango.readthedocs.io) for documentation on how Morango works.
18+
19+
### Getting started
20+
21+
To start contributing to Morango, first make sure you [have `uv` installed](https://docs.astral.sh/uv/getting-started/installation/).
22+
23+
Create a virtual environment, with at least python 3.9:
24+
```bash
25+
uv venv -p 3.10
26+
```
27+
28+
Then install dependencies:
29+
```bash
30+
uv sync --all-extras
31+
```
32+
33+
If you get during installation, you may need to install system packages such as `openssl` and `libssl-dev`.
34+
35+
Finally, set up pre-commit hooks:
36+
```bash
37+
prek install # with -f to reinstall
38+
```
39+
40+
### Docs
1841

1942
To build and edit the docs, run:
2043

2144
```bash
2245
# install requirements
23-
pip install -r requirements/docs.txt
24-
pip install -e .
46+
uv sync --extra docs
2547

2648
# build docs
2749
make docs

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ test = [
4848
]
4949

5050
dev = [
51-
# "pre-commit==4.1.0",
51+
"prek>=0.3.6; python_version>='3.8'",
5252
"tox>=4; python_version>='3.9'",
5353
"tox<4; python_version<'3.9'",
5454
"tox-uv>=1.0; python_version>='3.9'",

uv.lock

Lines changed: 26 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)