From 6decb37ae33032cfae5bd1d70f3e82a5523afa6a Mon Sep 17 00:00:00 2001 From: Your Name Date: Tue, 4 Jun 2024 23:29:55 -0400 Subject: [PATCH] update dev doc and gh actions --- .github/workflows/check.yml | 4 ++-- .github/workflows/tests.yml | 2 +- doc/development.md | 11 +++++------ 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 1ad18f66..2b797d33 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -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 diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index a6df4e94..72d23cfe 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -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:testpass@127.0.0.1/test_neodb diff --git a/doc/development.md b/doc/development.md index f6f92966..e463e1b5 100644 --- a/doc/development.md +++ b/doc/development.md @@ -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.