Skip to content

Commit

Permalink
update dev doc and gh actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Your Name authored and alphatownsman committed Jun 5, 2024
1 parent e31e7f1 commit 6decb37
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ jobs:
cache: pip
- name: Install dependencies
run: |
python -m pip install -r requirements-dev.txt
python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.lock
python -m pip install -r requirements.lock
- name: Run pyright
run: |
python -m pyright
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
cache: pip
- name: Install Dependencies
run: |
pip install -r requirements.txt
pip install -r requirements.lock
- name: Run Tests
env:
NEODB_DB_URL: postgres://testuser:[email protected]/test_neodb
Expand Down
11 changes: 5 additions & 6 deletions doc/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ cd neodb
git submodule update --init
```

Create and activate a Python virtual environment, optional but recommended.

Install development related packages and pre-commit hooks:
Install [rye](http://rye.astral.sh) package manager, packages and pre-commit hooks:
```
python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements-dev.txt
python3 -m pre_commit install
curl -sSf https://rye.astral.sh/get | bash
rye sync
. .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.
Expand Down

0 comments on commit 6decb37

Please sign in to comment.