# Esmerald
<p align="center">
<a href="https://esmerald.dymmond.com"><img src="https://res.cloudinary.com/dymmond/image/upload/v1671718628/esmerald/img/logo-gr_oyr4my.png" alt='Esmerald'></a>
</p>
<p align="center">
<em>🌟 An alternative SessionMiddleware for Esmerald with Pydantic at its core. 🌟</em>
</p>
<p align="center">
<a href="https://github.com/dymmond/esmerald-sessions/workflows/Test%20Suite/badge.svg?event=push&branch=main" target="_blank">
<img src="https://github.com/dymmond/esmerald-sessions/workflows/Test%20Suite/badge.svg?event=push&branch=main" alt="Test Suite">
</a>
<a href="https://pypi.org/project/esmerald" target="_blank">
<img src="https://img.shields.io/pypi/v/esmerald-sessions?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://pypi.org/project/esmerald" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/esmerald-sessions.svg?color=%2334D058" alt="Supported Python versions">
</a>
</p>
---
**Documentation**: [https://esmerald-sessions.dymmond.com](https://esmerald-sessions.dymmond.com) 📚
**Source Code**: [https://github.com/dymmond/esmerald-sessions](https://github.com/dymmond/esmerald-sessions)
---
## Motivation
Using the default `SessionMiddleware` from Esmerald might not be enough for those applications that need a bit more
than just a simple caching, for example, where to store that same cookie.
This package offers that possibility and allows the extension of it if needed.
Inspired by [Starlette Session](https://github.com/auredentan/starlette-session/blob/master/starlette_session) and with
Pydantic at its core, Esmerald sessions offers the best of both worlds.
## Requirements
* Python 3.7+
## Installation
```shell
$ pip install esmerald-sessions
```
## How to use
Please check the [documentation](https://esmerald-sessions.dymmond.com) how to use the package.
Raw data
{
"_id": null,
"home_page": "",
"name": "esmerald-sessions",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "api,asgi,esmerald,fastapi,framework,http,machine learning,ml,openapi,pydantic,rest,starlette,websocket",
"author": "",
"author_email": "Tiago Silva <tiago.silva@dymmond.com>",
"download_url": "https://files.pythonhosted.org/packages/b0/3c/17e4cf910611fb8bb6bbf1ca44696ef731a9ab3f2a849693cec546d79995/esmerald_sessions-0.2.0.tar.gz",
"platform": null,
"description": "# Esmerald\n\n<p align=\"center\">\n <a href=\"https://esmerald.dymmond.com\"><img src=\"https://res.cloudinary.com/dymmond/image/upload/v1671718628/esmerald/img/logo-gr_oyr4my.png\" alt='Esmerald'></a>\n</p>\n\n<p align=\"center\">\n <em>\ud83c\udf1f An alternative SessionMiddleware for Esmerald with Pydantic at its core. \ud83c\udf1f</em>\n</p>\n\n<p align=\"center\">\n<a href=\"https://github.com/dymmond/esmerald-sessions/workflows/Test%20Suite/badge.svg?event=push&branch=main\" target=\"_blank\">\n <img src=\"https://github.com/dymmond/esmerald-sessions/workflows/Test%20Suite/badge.svg?event=push&branch=main\" alt=\"Test Suite\">\n</a>\n\n<a href=\"https://pypi.org/project/esmerald\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/esmerald-sessions?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n</a>\n\n<a href=\"https://pypi.org/project/esmerald\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/pyversions/esmerald-sessions.svg?color=%2334D058\" alt=\"Supported Python versions\">\n</a>\n</p>\n\n---\n\n**Documentation**: [https://esmerald-sessions.dymmond.com](https://esmerald-sessions.dymmond.com) \ud83d\udcda\n\n**Source Code**: [https://github.com/dymmond/esmerald-sessions](https://github.com/dymmond/esmerald-sessions)\n\n---\n\n## Motivation\n\nUsing the default `SessionMiddleware` from Esmerald might not be enough for those applications that need a bit more\nthan just a simple caching, for example, where to store that same cookie.\n\nThis package offers that possibility and allows the extension of it if needed.\n\nInspired by [Starlette Session](https://github.com/auredentan/starlette-session/blob/master/starlette_session) and with\nPydantic at its core, Esmerald sessions offers the best of both worlds.\n\n## Requirements\n\n* Python 3.7+\n\n## Installation\n\n```shell\n$ pip install esmerald-sessions\n```\n\n## How to use\n\nPlease check the [documentation](https://esmerald-sessions.dymmond.com) how to use the package.\n",
"bugtrack_url": null,
"license": "",
"summary": "An alternative SessionMiddleware for Esmerald with Pydantic.",
"version": "0.2.0",
"split_keywords": [
"api",
"asgi",
"esmerald",
"fastapi",
"framework",
"http",
"machine learning",
"ml",
"openapi",
"pydantic",
"rest",
"starlette",
"websocket"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72e90e9a90897f81f1067d16b9e6b9c36ddbd58bbd682f61d4c6bbc9dd96a16d",
"md5": "dea23c137dc4d9bba610a0036aacacb3",
"sha256": "43ee5d05db3a650768d550617d1bd8c051f6c20d97169cc821a2cd6ea90865f8"
},
"downloads": -1,
"filename": "esmerald_sessions-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dea23c137dc4d9bba610a0036aacacb3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9569,
"upload_time": "2023-01-25T12:07:55",
"upload_time_iso_8601": "2023-01-25T12:07:55.272993Z",
"url": "https://files.pythonhosted.org/packages/72/e9/0e9a90897f81f1067d16b9e6b9c36ddbd58bbd682f61d4c6bbc9dd96a16d/esmerald_sessions-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b03c17e4cf910611fb8bb6bbf1ca44696ef731a9ab3f2a849693cec546d79995",
"md5": "7c1762c7618bdb04b4ab88e1462c4533",
"sha256": "b3d96771f4b0e8f6220c0f320be94bd57e34eff756ad384fd86789e033edfc13"
},
"downloads": -1,
"filename": "esmerald_sessions-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "7c1762c7618bdb04b4ab88e1462c4533",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7112,
"upload_time": "2023-01-25T12:07:56",
"upload_time_iso_8601": "2023-01-25T12:07:56.791471Z",
"url": "https://files.pythonhosted.org/packages/b0/3c/17e4cf910611fb8bb6bbf1ca44696ef731a9ab3f2a849693cec546d79995/esmerald_sessions-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-25 12:07:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "esmerald-sessions"
}
JSON