# authx-extra 💫
<p align="center">
<a href="https://authx.yezz.me" target="_blank">
<img src="https://user-images.githubusercontent.com/52716203/136962014-280d82b0-0640-4ee5-9a11-b451b338f6d8.png" alt="AuthX">
</a>
<p align="center">
<em>Extra utilities for authx, including session, profiler & caching ✨</em>
</p>
<p align="center">
<a href="https://github.com/yezz123/authx-extra/actions/workflows/ci.yml" target="_blank">
<img src="https://github.com/yezz123/authx-extra/actions/workflows/ci.yml/badge.svg" alt="ci">
</a>
<a href="https://pypi.org/project/authx-extra" target="_blank">
<img src="https://img.shields.io/pypi/v/authx-extra?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://codecov.io/gh/yezz123/authx-extra">
<img src="https://codecov.io/gh/yezz123/authx-extra/branch/main/graph/badge.svg"/>
</a>
</p>
</p>
---
**Source Code**: <https://github.com/yezz123/authx-extra>
**Documentation**: <https://authx.yezz.me/>
---
## Features 🔧
- [x] Using Redis as a session store & cache.
- [x] Support HTTPCache.
- [x] Support Sessions and Pre-built CRUD functions and Instance to launch Redis.
- [x] Support Middleware of [pyinstrument](https://pyinstrument.readthedocs.io/) to check your service performance.
- [x] Support Middleware for collecting and exposing [Prometheus](https://prometheus.io/) metrics.
## Development 🚧
### Setup environment 📦
You should create a virtual environment and activate it:
```bash
python -m venv venv/
```
```bash
source venv/bin/activate
```
And then install the development dependencies:
```bash
# Install dependencies
pip install -e .[test,lint]
```
### Run tests 🌝
You can run all the tests with:
```bash
bash scripts/docker.sh
```
### Format the code 🍂
Execute the following command to apply `pre-commit` formatting:
```bash
bash scripts/format.sh
```
## Links 🚧
- [Homepage](https://authx.yezz.me/)
- [FAQ](https://authx.yezz.me/faq/)
- [Release - AuthX](https://authx.yezz.me/release/)
- [MIT License](https://authx.yezz.me/license/)
- [Code of Conduct](https://authx.yezz.me/code_of_conduct/)
- [Help - Sponsors](https://authx.yezz.me/help/)
## License 📝
This project is licensed under the terms of the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "authx-extra",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Authentication, Cookie, FastAPI, JWT, Oauth2, Pydantic",
"author": null,
"author_email": "Yasser Tahiri <hello@yezz.me>",
"download_url": "https://files.pythonhosted.org/packages/02/6e/58900433185d12939ae0c0d6b5b7f3a97b55ef560370dc19f0799e6a5559/authx_extra-1.1.1.tar.gz",
"platform": null,
"description": "# authx-extra \ud83d\udcab\n\n<p align=\"center\">\n<a href=\"https://authx.yezz.me\" target=\"_blank\">\n <img src=\"https://user-images.githubusercontent.com/52716203/136962014-280d82b0-0640-4ee5-9a11-b451b338f6d8.png\" alt=\"AuthX\">\n</a>\n<p align=\"center\">\n <em>Extra utilities for authx, including session, profiler & caching \u2728</em>\n</p>\n<p align=\"center\">\n<a href=\"https://github.com/yezz123/authx-extra/actions/workflows/ci.yml\" target=\"_blank\">\n <img src=\"https://github.com/yezz123/authx-extra/actions/workflows/ci.yml/badge.svg\" alt=\"ci\">\n</a>\n<a href=\"https://pypi.org/project/authx-extra\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/authx-extra?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n</a>\n<a href=\"https://codecov.io/gh/yezz123/authx-extra\">\n <img src=\"https://codecov.io/gh/yezz123/authx-extra/branch/main/graph/badge.svg\"/>\n</a>\n</p>\n</p>\n\n---\n\n**Source Code**: <https://github.com/yezz123/authx-extra>\n\n**Documentation**: <https://authx.yezz.me/>\n\n---\n\n## Features \ud83d\udd27\n\n- [x] Using Redis as a session store & cache.\n- [x] Support HTTPCache.\n- [x] Support Sessions and Pre-built CRUD functions and Instance to launch Redis.\n- [x] Support Middleware of [pyinstrument](https://pyinstrument.readthedocs.io/) to check your service performance.\n- [x] Support Middleware for collecting and exposing [Prometheus](https://prometheus.io/) metrics.\n\n## Development \ud83d\udea7\n\n### Setup environment \ud83d\udce6\n\nYou should create a virtual environment and activate it:\n\n```bash\npython -m venv venv/\n```\n\n```bash\nsource venv/bin/activate\n```\n\nAnd then install the development dependencies:\n\n```bash\n# Install dependencies\npip install -e .[test,lint]\n```\n\n### Run tests \ud83c\udf1d\n\nYou can run all the tests with:\n\n```bash\nbash scripts/docker.sh\n```\n\n### Format the code \ud83c\udf42\n\nExecute the following command to apply `pre-commit` formatting:\n\n```bash\nbash scripts/format.sh\n```\n\n## Links \ud83d\udea7\n\n- [Homepage](https://authx.yezz.me/)\n- [FAQ](https://authx.yezz.me/faq/)\n- [Release - AuthX](https://authx.yezz.me/release/)\n- [MIT License](https://authx.yezz.me/license/)\n- [Code of Conduct](https://authx.yezz.me/code_of_conduct/)\n- [Help - Sponsors](https://authx.yezz.me/help/)\n\n## License \ud83d\udcdd\n\nThis project is licensed under the terms of the MIT License.\n",
"bugtrack_url": null,
"license": null,
"summary": "Extra utilities for authx, including session, profiler & caching \u2728",
"version": "1.1.1",
"project_urls": {
"Documentation": "https://authx.yezz.me/installation/#extra-dependencies",
"Funding": "https://github.com/sponsors/yezz123",
"Homepage": "https://github.com/yezz123/authx_extra"
},
"split_keywords": [
"authentication",
" cookie",
" fastapi",
" jwt",
" oauth2",
" pydantic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c7eb2c6f4854e6f10168c9e3767c5689b1eafa3e4a8800cd85fd4982161e0c61",
"md5": "87b9a92b79c0e2991778a2d95542732a",
"sha256": "0389fa0ee17c42a57f2b6affe2cf3ca476d4540824b7a4484851a703605329ec"
},
"downloads": -1,
"filename": "authx_extra-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87b9a92b79c0e2991778a2d95542732a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14175,
"upload_time": "2024-04-04T18:05:35",
"upload_time_iso_8601": "2024-04-04T18:05:35.645904Z",
"url": "https://files.pythonhosted.org/packages/c7/eb/2c6f4854e6f10168c9e3767c5689b1eafa3e4a8800cd85fd4982161e0c61/authx_extra-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "026e58900433185d12939ae0c0d6b5b7f3a97b55ef560370dc19f0799e6a5559",
"md5": "68b386f0c854d42b7c36d067ebf25ef4",
"sha256": "5ed0ba8d3beb4d721a0e56409131d163b14a7b0985c6e7ae028aa10f6d739899"
},
"downloads": -1,
"filename": "authx_extra-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "68b386f0c854d42b7c36d067ebf25ef4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22959,
"upload_time": "2024-04-04T18:05:37",
"upload_time_iso_8601": "2024-04-04T18:05:37.615460Z",
"url": "https://files.pythonhosted.org/packages/02/6e/58900433185d12939ae0c0d6b5b7f3a97b55ef560370dc19f0799e6a5559/authx_extra-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 18:05:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "yezz123",
"github_not_found": true,
"lcname": "authx-extra"
}
JSON
