Metadata-Version: 2.1
Name: cherrypy-cors
Version: 1.7.0
Summary: CORS handling as a cherrypy tool.
Home-page: https://github.com/cherrypy/cherrypy-cors
Author: Jason R. Coombs
Author-email: jaraco@jaraco.com
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
License-File: LICENSE
Requires-Dist: cherrypy>=3
Requires-Dist: httpagentparser>=1.5
Provides-Extra: testing
Requires-Dist: pytest>=6; extra == "testing"
Requires-Dist: pytest-checkdocs>=2.4; extra == "testing"
Requires-Dist: pytest-black>=0.3.7; platform_python_implementation != "PyPy" and extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"
Requires-Dist: pytest-mypy>=0.9.1; platform_python_implementation != "PyPy" and extra == "testing"
Requires-Dist: pytest-enabler>=2.2; extra == "testing"
Requires-Dist: pytest-ruff; extra == "testing"
Requires-Dist: pygments; extra == "testing"
Provides-Extra: docs
Requires-Dist: sphinx>=3.5; extra == "docs"
Requires-Dist: jaraco.packaging>=9.3; extra == "docs"
Requires-Dist: rst.linker>=1.9; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: sphinx-lint; extra == "docs"

.. image:: https://img.shields.io/pypi/v/cherrypy-cors.svg
   :target: https://pypi.org/project/cherrypy-cors

.. image:: https://img.shields.io/pypi/pyversions/cherrypy-cors.svg

.. image:: https://github.com/cherrypy/cherrypy-cors/workflows/tests/badge.svg
   :target: https://github.com/cherrypy/cherrypy-cors/actions?query=workflow%3A%22tests%22
   :alt: tests

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Code style: Black

.. image:: https://readthedocs.org/projects/cherrypy-cors/badge/?version=latest
   :target: https://cherrypy-cors.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/skeleton-2023-informational
   :target: https://blog.jaraco.com/skeleton

CORS support for CherryPy

In a nutshell
=============

In your application, either install the tool globally.

.. code-block:: python

    import cherrypy_cors
    cherrypy_cors.install()

Or add it to your application explicitly.

.. code-block:: python

    import cherrypy_cors
    app = cherrypy.tree.mount(...)
    app.toolboxes['cors'] = cherrypy_cors.tools

Then, enable it in your cherrypy config. For example, to enable it for all
static resources.

.. code-block:: python

    config = {
        '/static': {
            'tools.staticdir.on': True,
            'cors.expose.on': True,
        }
    }

See `simple-example
<https://github.com/yougov/cherrypy-cors/blob/master/simple-example.py>`_
for a runnable example.
