Metadata-Version: 1.1
Name: Sanic-Cors
Version: 0.9.0
Summary: A Sanic extension adding a decorator for CORS support. Based on flask-cors by Cory Dolphin.
Home-page: https://github.com/ashleysommer/sanic-cors
Author: Ashley Sommer
Author-email: ashleysommer@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: Sanic-CORS
        ==========
        
        |Build Status| |Latest Version| |Supported Python versions|
        |License|
        
        A Sanic extension for handling Cross Origin Resource Sharing (CORS),
        making cross-origin AJAX possible. Based on flask-cors by Cory Dolphin.
        
        This package has a simple philosophy, when you want to enable CORS, you
        wish to enable it for all use cases on a domain. This means no mucking
        around with different allowed headers, methods, etc. By default,
        submission of cookies across domains is disabled due to the security
        implications, please see the documentation for how to enable
        credential'ed requests, and please make sure you add some sort of
        `CSRF <http://en.wikipedia.org/wiki/Cross-site_request_forgery>`__
        protection before doing so!
        
        Installation
        ------------
        
        Install the extension with using pip, or easy\_install.
        
        .. code:: bash
        
            $ pip install -U sanic-cors
        
        Usage
        -----
        
        This package exposes a Sanic extension which by default enables CORS support on all routes, for all origins and methods. It allows parameterization of all CORS headers on a per-resource level. The package also contains a decorator, for those who prefer this approach.
        
        Simple Usage
        ~~~~~~~~~~~~
        
        In the simplest case, initialize the Sanic-Cors extension with default
        arguments in order to allow CORS for all domains on all routes. See the
        full list of options in the `documentation <http://sanic-cors.corydolphin.com/en/latest/api.html#extension>`__.
        
        .. code:: python
        
        
            from sanic import Sanic
            from sanic.response import text
            from sanic_cors import CORS, cross_origin
        
            app = Sanic(__name__)
            CORS(app)
        
            @app.route("/", methods=['GET', 'OPTIONS'])
            def hello_world(request):
              return text("Hello, cross-origin-world!")
        
        Resource specific CORS
        ^^^^^^^^^^^^^^^^^^^^^^
        
        Alternatively, you can specify CORS options on a resource and origin
        level of granularity by passing a dictionary as the `resources` option,
        mapping paths to a set of options. See the
        full list of options in the `documentation <http://sanic-cors.corydolphin.com/en/latest/api.html#extension>`__.
        
        .. code:: python
        
            app = Sanic(__name__)
            cors = CORS(app, resources={r"/api/*": {"origins": "*"}})
        
            @app.route("/api/v1/users", methods=['GET', 'OPTIONS'])
            def list_users(request):
              return text("user example")
        
        Route specific CORS via decorator
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        This extension also exposes a simple decorator to decorate sanic routes
        with. Simply add ``@cross_origin(app)`` below a call to Sanic's
        ``@app.route(..)`` to allow CORS on a given route. See the
        full list of options in the `decorator documentation <http://sanic-cors.corydolphin.com/en/latest/api.html#decorator>`__.
        
        .. code:: python
        
            @app.route("/", methods=['GET', 'OPTIONS'])
            @cross_origin(app)
            def hello_world(request):
              return text("Hello, cross-origin-world!")
        
        Documentation
        -------------
        
        For a full list of options, please see the full
        `documentation <http://sanic-cors.corydolphin.com/en/latest/>`__
        
        Preflight Requests
        ------------------
        CORS requests have to send `pre-flight requests <https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS#Preflighted_requests_in_CORS>`_
        via the options method, Sanic by default only allows the GET method, in order to
        service your CORS requests you must specify 'OPTIONS' in the methods argument to
        your routes decorator.
        
        Troubleshooting
        ---------------
        
        If things aren't working as you expect, enable logging to help understand
        what is going on under the hood, and why.
        
        .. code:: python
        
            logging.getLogger('sanic_cors').level = logging.DEBUG
        
        
        Tests
        -----
        
        A simple set of tests is included in ``test/``. To run, install nose,
        and simply invoke ``nosetests`` or ``python setup.py test`` to exercise
        the tests.
        
        Contributing
        ------------
        
        Questions, comments or improvements? Please create an issue on
        `Github <https://github.com/ashleysommer/sanic-cors>`__, tweet at
        `@corydolphin <https://twitter.com/corydolphin>`__ or send me an email.
        I do my best to include every contribution proposed in any way that I
        can.
        
        Credits
        -------
        
        This Sanic extension is based upon the `Decorator for the HTTP Access
        Control <http://flask.pocoo.org/snippets/56/>`__ written by Armin
        Ronacher.
        
        .. |Build Status| image:: https://api.travis-ci.org/ashleysommer/sanic-cors.svg?branch=master
           :target: https://travis-ci.org/ashleysommer/sanic-cors
        .. |Latest Version| image:: https://img.shields.io/pypi/v/Sanic-Cors.svg
           :target: https://pypi.python.org/pypi/Sanic-Cors/
        .. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/Sanic-Cors.svg
           :target: https://img.shields.io/pypi/pyversions/Sanic-Cors.svg
        .. |License| image:: http://img.shields.io/:license-mit-blue.svg
           :target: https://pypi.python.org/pypi/Sanic-Cors/
        
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
