.. image:: https://raw.githubusercontent.com/sanic-org/sanic-assets/master/png/sanic-framework-logo-400x97.png
:alt: Sanic | Build fast. Run fast.
Sanic Extensions
================
.. start-badges
.. list-table::
:widths: 15 85
:stub-columns: 1
* - Build
- | |PyTest|
* - Docs
- | |UserGuide|
* - Package
- | |PyPI| |PyPI version| |Wheel| |Supported implementations| |Code style black|
* - Support
- | |Forums| |Discord|
.. |UserGuide| image:: https://img.shields.io/badge/user%20guide-sanic-ff0068
:target: https://sanicframework.org/en/plugins/sanic-ext/getting-started.html
.. |Forums| image:: https://img.shields.io/badge/forums-community-ff0068.svg
:target: https://community.sanicframework.org/
.. |Discord| image:: https://img.shields.io/discord/812221182594121728?logo=discord
:target: https://discord.gg/FARQzAEMAA
.. |PyTest| image:: https://github.com/sanic-org/sanic-ext/actions/workflows/python-package.yml/badge.svg?branch=main
:target: https://github.com/sanic-org/sanic-ext/actions/workflows/python-package.yml
.. |PyPI| image:: https://img.shields.io/pypi/v/sanic-ext.svg
:target: https://pypi.python.org/pypi/sanic-ext/
.. |PyPI version| image:: https://img.shields.io/pypi/pyversions/sanic-ext.svg
:target: https://pypi.python.org/pypi/sanic-ext/
.. |Code style black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
.. |Wheel| image:: https://img.shields.io/pypi/wheel/sanic-ext.svg
:alt: PyPI Wheel
:target: https://pypi.python.org/pypi/sanic-ext
.. |Supported implementations| image:: https://img.shields.io/pypi/implementation/sanic-ext.svg
:alt: Supported implementations
:target: https://pypi.python.org/pypi/sanic-ext
.. end-badges
`Sanic <https://github.com/sanic-org/sanic>`_ strives to be "Unopinionated and flexible"::
Build the way you want to build without letting your tooling constrain you.
But what happens when you want all the goodies? Sanic Extensions is an officially supported Sanic plugin to provide application developers with additional tools and features.
Features
--------
- Auto create HEAD, OPTIONS, and TRACE endpoints
- CORS protection
- Predefined, endpoint-specific response serializers
- Argument injection into route handlers
- OpenAPI documentation with Redoc and/or Swagger
- Request query arguments and body input validation
Installation
------------
::
pip install sanic[ext]
# OR
pip install sanic sanic-ext
Getting started
---------------
.. code-block:: python
from sanic import Sanic
app = Sanic("MyHelloWorldApp")
Nothing new. Just start using Sanic and it will automatically be extended!
Learn more
----------
Go to the `User Guide <https://sanicframework.org/en/plugins/sanic-ext/getting-started.html>`_ to learn more
____
.. warning:: Sanic Extensions is still in **ALPHA** release. The API is not likely to change. It will move to **BETA** with v22.3.
Raw data
{
"_id": null,
"home_page": "http://github.com/sanic-org/sanic-ext/",
"name": "sanic-ext",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Sanic Community",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7d/bf/807ded5b25f5576173c4603a1f16f67150b63eb899b0996231d88b10b90f/sanic-ext-23.12.0.tar.gz",
"platform": "any",
"description": ".. image:: https://raw.githubusercontent.com/sanic-org/sanic-assets/master/png/sanic-framework-logo-400x97.png\n :alt: Sanic | Build fast. Run fast.\n\nSanic Extensions\n================\n\n.. start-badges\n\n.. list-table::\n :widths: 15 85\n :stub-columns: 1\n\n * - Build\n - | |PyTest|\n * - Docs\n - | |UserGuide|\n * - Package\n - | |PyPI| |PyPI version| |Wheel| |Supported implementations| |Code style black|\n * - Support\n - | |Forums| |Discord|\n\n\n.. |UserGuide| image:: https://img.shields.io/badge/user%20guide-sanic-ff0068\n :target: https://sanicframework.org/en/plugins/sanic-ext/getting-started.html\n.. |Forums| image:: https://img.shields.io/badge/forums-community-ff0068.svg\n :target: https://community.sanicframework.org/\n.. |Discord| image:: https://img.shields.io/discord/812221182594121728?logo=discord\n :target: https://discord.gg/FARQzAEMAA\n.. |PyTest| image:: https://github.com/sanic-org/sanic-ext/actions/workflows/python-package.yml/badge.svg?branch=main\n :target: https://github.com/sanic-org/sanic-ext/actions/workflows/python-package.yml\n.. |PyPI| image:: https://img.shields.io/pypi/v/sanic-ext.svg\n :target: https://pypi.python.org/pypi/sanic-ext/\n.. |PyPI version| image:: https://img.shields.io/pypi/pyversions/sanic-ext.svg\n :target: https://pypi.python.org/pypi/sanic-ext/\n.. |Code style black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/ambv/black\n.. |Wheel| image:: https://img.shields.io/pypi/wheel/sanic-ext.svg\n :alt: PyPI Wheel\n :target: https://pypi.python.org/pypi/sanic-ext\n.. |Supported implementations| image:: https://img.shields.io/pypi/implementation/sanic-ext.svg\n :alt: Supported implementations\n :target: https://pypi.python.org/pypi/sanic-ext\n\n\n.. end-badges\n\n\n`Sanic <https://github.com/sanic-org/sanic>`_ strives to be \"Unopinionated and flexible\"::\n\n Build the way you want to build without letting your tooling constrain you.\n\nBut what happens when you want all the goodies? Sanic Extensions is an officially supported Sanic plugin to provide application developers with additional tools and features.\n\nFeatures\n--------\n\n- Auto create HEAD, OPTIONS, and TRACE endpoints\n- CORS protection\n- Predefined, endpoint-specific response serializers\n- Argument injection into route handlers\n- OpenAPI documentation with Redoc and/or Swagger\n- Request query arguments and body input validation\n\n\nInstallation\n------------\n\n::\n\n pip install sanic[ext]\n # OR\n pip install sanic sanic-ext\n\n\nGetting started\n---------------\n\n\n.. code-block:: python\n\n from sanic import Sanic\n\n app = Sanic(\"MyHelloWorldApp\")\n \nNothing new. Just start using Sanic and it will automatically be extended!\n\n\nLearn more\n----------\n\n\nGo to the `User Guide <https://sanicframework.org/en/plugins/sanic-ext/getting-started.html>`_ to learn more\n\n____\n\n.. warning:: Sanic Extensions is still in **ALPHA** release. The API is not likely to change. It will move to **BETA** with v22.3.\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Extend your Sanic installation with some core functionality.",
"version": "23.12.0",
"project_urls": {
"Homepage": "http://github.com/sanic-org/sanic-ext/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c242140f19f464e6fe6597e7274341751b72466acc360bbd70013cca1f3249b1",
"md5": "1241e3902bc77a6bec9f338edafbff60",
"sha256": "3ba2c143d7c41d89b87a11c6214b9d9b52c3994ff8ce3a03792b54ec5627e2c3"
},
"downloads": -1,
"filename": "sanic_ext-23.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1241e3902bc77a6bec9f338edafbff60",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 95228,
"upload_time": "2023-12-31T10:36:26",
"upload_time_iso_8601": "2023-12-31T10:36:26.278538Z",
"url": "https://files.pythonhosted.org/packages/c2/42/140f19f464e6fe6597e7274341751b72466acc360bbd70013cca1f3249b1/sanic_ext-23.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7dbf807ded5b25f5576173c4603a1f16f67150b63eb899b0996231d88b10b90f",
"md5": "081d0a37618cb75f5f79a9269dbf1fa7",
"sha256": "42fc41e7fafa58f3b790f685f3dd8a8de281460b4169d0e91f4e11b8747f845c"
},
"downloads": -1,
"filename": "sanic-ext-23.12.0.tar.gz",
"has_sig": false,
"md5_digest": "081d0a37618cb75f5f79a9269dbf1fa7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 64959,
"upload_time": "2023-12-31T10:36:28",
"upload_time_iso_8601": "2023-12-31T10:36:28.190864Z",
"url": "https://files.pythonhosted.org/packages/7d/bf/807ded5b25f5576173c4603a1f16f67150b63eb899b0996231d88b10b90f/sanic-ext-23.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-31 10:36:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sanic-org",
"github_project": "sanic-ext",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "sanic-ext"
}
JSON
