fix: codecov support, docs simplify

aliev · Jan 25, 2025 · 08939bf · 08939bf
1 parent 6a8ff3e
commit 08939bf
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 137 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,14 +24,14 @@ jobs:
     - name: Install dependencies
       run: |
         make dev-install
-        pip install codecov
     - name: Run lint
       run: |
         make lint
     - name: Run tests
       run: |
         make test
-    - name: Upload test coverage
-      run: codecov
-      env:
-        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    - name: Upload test results to Codecov
+      if: ${{ !cancelled() }}
+      uses: codecov/test-results-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/Makefile b/Makefile
@@ -51,7 +51,8 @@ lint: ## check style with flake8
 	pre-commit run --all-files
 
 test: ## run tests quickly with the default Python
-	pytest tests
+	coverage run -m pytest tests
+	coverage xml -o junit.xml
 
 release: dist ## package and upload a release
 	twine upload dist/*

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Coverage](https://badgen.net/codecov/c/github/aliev/aioauth)](https://app.codecov.io/gh/aliev/aioauth)
 [![License](https://img.shields.io/github/license/aliev/aioauth)](https://github.com/aliev/aioauth/blob/master/LICENSE)
 [![PyPi](https://badgen.net/pypi/v/aioauth)](https://pypi.org/project/aioauth/)
-[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
+[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
 
 `aioauth` implements [OAuth 2.0 protocol](https://tools.ietf.org/html/rfc6749) and can be used in asynchronous frameworks like [FastAPI / Starlette](https://github.com/tiangolo/fastapi), [aiohttp](https://github.com/aio-libs/aiohttp). It can work with any databases like `MongoDB`, `PostgreSQL`, `MySQL` and ORMs like [gino](https://python-gino.org/), [sqlalchemy](https://www.sqlalchemy.org/) or [databases](https://pypi.org/project/databases/) over simple [BaseStorage](aioauth/storage.py) interface.
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,20 +1,22 @@
 # -- Path setup --------------------------------------------------------------
 
 from pathlib import Path
+import tomllib
+from aioauth import __version__
 
 # Project root folder.
 root = Path(__file__).parent.parent.parent
 
 # Loads __version__ file.
 about = {}
-with open(root / "aioauth" / "__version__.py", "r") as f:
-    exec(f.read(), about)
+with open(root / "pyproject.toml", "rb") as f:
+    about = tomllib.load(f)
 
 # -- Project information -----------------------------------------------------
 
-project = about["__title__"]
-author = about["__author__"]
-release = about["__version__"]
+project = about["project"]["description"]
+author = about["project"]["authors"][0]["name"]
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/docs/source/contents.rst b/docs/source/contents.rst
@@ -15,20 +15,6 @@
   :glob:
   :maxdepth: 2
 
-  sections/using/*
-
-.. toctree::
-  :caption: Examples
-  :glob:
-  :maxdepth: 2
-
-  sections/examples/*
-
-.. toctree::
-  :caption: Documentation
-  :glob:
-  :maxdepth: 3
-
   sections/documentation/*
 
 .. toctree::

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -33,7 +33,7 @@ aioauth supports the following RFCs:
 Pages
 -----
 
-* `Github Project <https://github.com/aliev/aioauth/pull/21>`_
+* `Github Project <https://github.com/aliev/aioauth>`_
 * `Issues <https://github.com/aliev/aioauth/issues>`_
 * `Discussion <https://github.com/aliev/aioauth/discussions>`_
 

diff --git a/docs/source/sections/examples/aiohttp.rst b/docs/source/sections/examples/aiohttp.rst
diff --git a/docs/source/sections/examples/fastapi.rst b/docs/source/sections/examples/fastapi.rst
diff --git a/docs/source/sections/using/configuration.rst b/docs/source/sections/using/configuration.rst
diff --git a/docs/source/sections/using/server_database.rst b/docs/source/sections/using/server_database.rst