-
Notifications
You must be signed in to change notification settings - Fork 239
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
78 changed files
with
2,658 additions
and
1,165 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,11 @@ | ||
| name: Ruff | ||
| on: [push, pull_request] | ||
| jobs: | ||
| ruff: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: chartboost/ruff-action@v1 | ||
| ruff: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: chartboost/ruff-action@v1 | ||
| with: | ||
| version: 0.1.11 | ||
| args: --select B |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,21 @@ | ||
| name: Run unittests | ||
| on: [push, pull_request] | ||
| jobs: | ||
| unittests: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: supercharge/[email protected] | ||
| - uses: niden/actions-memcached@v7 | ||
| - uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: 'pypy3.9' | ||
| - name: Install testing requirements | ||
| run: pip3 install -r requirements/pytest.txt | ||
| - name: Run tests | ||
| run: pytest tests | ||
| unittests: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| python-version: [3.8, 3.9, 3.10, 3.11, 3.12] | ||
| services: | ||
| mongodb: | ||
| image: mongo | ||
| ports: | ||
| - 27017:27017 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: supercharge/[email protected] | ||
| - uses: niden/actions-memcached@v7 | ||
| - name: Install testing requirements | ||
| run: pip3 install -r requirements/dev.txt | ||
| - name: Run tests | ||
| run: pytest tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,79 @@ | ||
| Getting started | ||
| ------------- | ||
| ----------------- | ||
| Using pip | ||
| ~~~~~~~~~~~ | ||
|
|
||
| Navigate to the project directory and run the following commands: | ||
|
|
||
| Create and activate a virtual environment | ||
| .. code-block:: text | ||
| python -m venv .venv | ||
| .\venv\bin\activate | ||
|
|
||
| .. code-block:: bash | ||
| $ python -m venv .venv | ||
| $ source .venv/bin/activate | ||
| Install dependencies | ||
| .. code-block:: text | ||
| pip install -r requirements/dev.txt | ||
| pip install -r requirements/pytest.txt | ||
|
|
||
| .. code-block:: bash | ||
| Install Memecached and Redis and activate local server (optional) | ||
| .. code-block:: text | ||
| brew install memcached | ||
| brew install redis | ||
| $ pip install -r requirements/dev.in | ||
| $ pip install -r requirements/docs.in | ||
| Install the package in editable mode | ||
|
|
||
| .. code-block:: bash | ||
| $ pip install -e . | ||
| Lint the code | ||
|
|
||
| .. code-block:: bash | ||
| $ ruff check --fix | ||
| Build updated documentation locally | ||
|
|
||
| .. code-block:: bash | ||
| $ cd docs | ||
| $ make html | ||
| or | ||
|
|
||
| .. code-block:: bash | ||
| $ sphinx-build -b html docs docs/_build | ||
| Run the tests together or individually | ||
| .. code-block:: text | ||
| pytest tests | ||
| pytest tests/test_basic.py | ||
|
|
||
| .. code-block:: bash | ||
| $ pytest tests | ||
| $ pytest tests/test_basic.py | ||
| For easier startup and teardown of storage for testing you may use | ||
|
|
||
| .. code-block:: bash | ||
| $ docker-compose up -d | ||
| $ docker-compose down | ||
| Using rye | ||
| ~~~~~~~~~~~ | ||
|
|
||
| .. code-block:: bash | ||
| $ rye pin 3.11 | ||
| $ rye sync | ||
| .. code-block:: bash | ||
| $ rye run python examples/hello.py | ||
| etc. | ||
|
|
||
| Pull requests | ||
| ------------- | ||
| -------------- | ||
| Please check previous pull requests before submitting a new one. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ## Contributors | ||
|
|
||
| - [nebolax](https://github.com/nebolax) | ||
| - [Taragolis](https://github.com/Taragolis) | ||
| - [Lxstr](https://github.com/Lxstr) | ||
| - [yrro](https://github.com/yrro) | ||
| - [hluk](https://github.com/hluk) | ||
| - [idoshr](https://github.com/idoshr) | ||
| - [rayluo](https://github.com/rayluo) | ||
| - [davidism](https://github.com/davidism) | ||
| - [idocyabra](https://github.com/idocyabra) | ||
| - [darless](https://github.com/darless) | ||
| - [SqrtMinusOne](https://github.com/SqrtMinusOne) | ||
| - [tylersalminen](https://github.com/tylersalminen) | ||
| - [warrenbailey](https://github.com/warrenbailey) | ||
| - [imacat](https://github.com/imacat) | ||
| - [kim-sondrup](https://github.com/kim-sondrup) | ||
| - [bnjmn](https://github.com/bnjmn) | ||
| - [christopherpickering](https://github.com/christopherpickering) | ||
|
|
||
| ## Original Author | ||
|
|
||
| - [fengsp](https://github.com/fengsp) |
Oops, something went wrong.