update dev doc and gh actions

This commit is contained in:
Your Name 2024-06-04 23:29:55 -04:00 committed by Henri Dickson
parent e31e7f169a
commit 6decb37ae3
3 changed files with 8 additions and 9 deletions

View file

@ -37,8 +37,8 @@ jobs:
cache: pip cache: pip
- name: Install dependencies - name: Install dependencies
run: | run: |
python -m pip install -r requirements-dev.txt python -m pip install -r requirements-dev.lock
python -m pip install -r requirements.txt python -m pip install -r requirements.lock
- name: Run pyright - name: Run pyright
run: | run: |
python -m pyright python -m pyright

View file

@ -42,7 +42,7 @@ jobs:
cache: pip cache: pip
- name: Install Dependencies - name: Install Dependencies
run: | run: |
pip install -r requirements.txt pip install -r requirements.lock
- name: Run Tests - name: Run Tests
env: env:
NEODB_DB_URL: postgres://testuser:testpass@127.0.0.1/test_neodb NEODB_DB_URL: postgres://testuser:testpass@127.0.0.1/test_neodb

View file

@ -21,13 +21,12 @@ cd neodb
git submodule update --init git submodule update --init
``` ```
Create and activate a Python virtual environment, optional but recommended. Install [rye](http://rye.astral.sh) package manager, packages and pre-commit hooks:
Install development related packages and pre-commit hooks:
``` ```
python3 -m pip install -r requirements.txt curl -sSf https://rye.astral.sh/get | bash
python3 -m pip install -r requirements-dev.txt rye sync
python3 -m pre_commit install . .venv/bin/activate
pre-commit install
``` ```
To develop Takahe, install requirements(-dev) and pre-commit hooks for `neodb-takahe` project as well, preferably using a different virtual environment. To develop Takahe, install requirements(-dev) and pre-commit hooks for `neodb-takahe` project as well, preferably using a different virtual environment.