Skip to content

Commit

Permalink
chore!: rename optional dependency
Browse files Browse the repository at this point in the history
* `test` -> `tests`
  • Loading branch information
korikuzma committed Dec 30, 2024
1 parent f217f66 commit 724310c
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ jobs:

- name: Install DynamoDB dependencies
if: ${{ env.GENE_NORM_DB_URL == 'http://localhost:8000' }}
run: python3 -m pip install ".[etl,test]"
run: python3 -m pip install ".[etl,tests]"

- name: Install PG dependencies
if: ${{ env.GENE_NORM_DB_URL != 'http://localhost:8000' }}
run: python3 -m pip install ".[pg,etl,test]"
run: python3 -m pip install ".[pg,etl,tests]"

- name: Build local DynamoDB
if: ${{ env.GENE_NORM_DB_URL == 'http://localhost:8000' }}
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Alternatively, use a virtual environment and install all dependency groups: ::

python3 -m venv venv
source venv/bin/activate
python3 -m pip install -e ".[pg,etl,test,dev,docs]"
python3 -m pip install -e ".[pg,etl,tests,dev,docs]"

We use `pre-commit <https://pre-commit.com/#usage>`_ to run conformance tests before commits. This provides checks for:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Gene Normalizer can be installed from `PyPI <https://pypi.org/project/gene-n
* ``etl`` provides dependencies for regenerating data from sources. It's necessary for users who don't intend to rely on existing database dumps.
* ``pg`` provides dependencies for connecting to a PostgreSQL database. It's not necessary for users who are using a DynamoDB backend.
* ``dev`` provides development dependencies, such as static code analysis. It's required for contributing to the Gene Normalizer, but otherwise unnecessary.
* ``test`` provides dependencies for running tests. As with ``dev``, it's mostly relevant for contributors.
* ``tests`` provides dependencies for running tests. As with ``dev``, it's mostly relevant for contributors.
* ``docs`` provides dependencies for documentation generation. It's only relevant for contributors.

.. _quick-install:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ etl = [
"wags-tails~=0.2.1",
"setuptools", # pinned for 3.12 because yoyo-migrations still uses pkg_resources
]
test = ["pytest>=6.0", "pytest-cov", "mock", "httpx", "deepdiff"]
tests = ["pytest>=6.0", "pytest-cov", "mock", "httpx", "deepdiff"]
dev = ["pre-commit>=3.7.1", "ruff==0.5.0"]
docs = [
"sphinx==6.1.3",
Expand Down

0 comments on commit 724310c

Please sign in to comment.