Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rwanyoike committed Oct 7, 2024
1 parent e7dd5ea commit 8a63e97
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 28 deletions.
28 changes: 14 additions & 14 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Python package
name: "Python package"

on:
push:
Expand All @@ -9,28 +9,28 @@ on:

jobs:
build:
runs-on: ubuntu-latest
runs-on: "ubuntu-latest"
strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
steps:
- name: Checkout ${{ github.repository }}
uses: actions/checkout@v4
- name: Install poetry using pipx
- name: "Checkout ${{ github.repository }}"
uses: "actions/checkout@v4"
- name: "Install poetry using pipx"
run: |
pipx install poetry==1.8.3
poetry config virtualenvs.in-project true
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
- name: "Set up Python ${{ matrix.python-version }}"
uses: "actions/setup-python@v5"
with:
python-version: ${{ matrix.python-version }}
cache: poetry
- name: Install dependencies
run: poetry install
- name: Run Ruff checks
python-version: "${{ matrix.python-version }}"
cache: "poetry"
- name: "Install dependencies"
run: "poetry install"
- name: "Run Ruff checks"
run: |
poetry run ruff check --select I
poetry run ruff format --check
- name: Test with pytest
run: poetry run pytest --cov=time2relax
- name: "Test with pytest"
run: "poetry run pytest --cov=time2relax"
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
__pycache__/
.mypy_cache/
.pytest_cache/
.ruff_cache/
.venv/
Expand Down
4 changes: 4 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Version History

## 0.7.0 (2024-05-05)

- Drop Python 3.6, 3.7 support - Python 3.7 will not be maintained past 2023.

## 0.6.0 (2020-01-28)

- Drop Python 2.7 support - Python 2.7 will not be maintained past 2020.
Expand Down
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Inspired by [pouchdb](https://github.com/pouchdb/pouchdb) and [couchdb-nano](ht
- HTTP exceptions modeled from CouchDB [error codes](http://docs.couchdb.org/en/1.6.1/api/basics.html#http-status-codes).
- Transparent URL and parameter encoding.

time2relax officially supports Python 3.6+; CouchDB 1.7+.
time2relax officially supports Python 3.8+; CouchDB 1.7+.

## Installation

Expand All @@ -44,15 +44,3 @@ $ pip install -U time2relax
## Usage

For documentation, see [`./docs/README.md`](./docs/README.md).

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

This project is licensed under the [MIT License](./LICENSE).

## Related Projects

- [couchutils](https://github.com/rwanyoike/couchutils) - A collection of CouchDB utils.

0 comments on commit 8a63e97

Please sign in to comment.