Skip to main content

A Flask extension adding a decorator for CORS support

Project description

Build Status Latest Version Supported Python versions License

A Flask extension for handling Cross Origin Resource Sharing (CORS), making cross-origin AJAX possible.

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 protection before doing so!

Installation

Install the extension with using pip, or easy_install.

$ pip install -U flask-cors

Usage

This package exposes a Flask 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 Flask-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.

from flask import Flask
from flask_cors import CORS, cross_origin

app = Flask(__name__)
CORS(app)

@app.route("/")
def helloWorld():
  return "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.

app = Flask(__name__)
cors = CORS(app, resources={r"/api/*": {"origins": "*"}})

@app.route("/api/v1/users")
def list_users():
  return "user example"

Route specific CORS via decorator

This extension also exposes a simple decorator to decorate flask routes with. Simply add @cross_origin() below a call to Flask’s @app.route(..) to allow CORS on a given route. See the full list of options in the decorator documentation.

@app.route("/")
@cross_origin()
def helloWorld():
  return "Hello, cross-origin-world!"

Documentation

For a full list of options, please see the full documentation

Troubleshooting

If things aren’t working as you expect, enable logging to help understand what is going on under the hood, and why.

logging.getLogger('flask_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, tweet at @corydolphin or send me an email. I do my best to include every contribution proposed in any way that I can.

Credits

This Flask extension is based upon the Decorator for the HTTP Access Control written by Armin Ronacher.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Cors-3.0.3.tar.gz (28.4 kB view details)

Uploaded Source

Built Distributions

Flask_Cors-3.0.3-py2.py3-none-any.whl (15.9 kB view details)

Uploaded Python 2Python 3

Flask_Cors-3.0.3-py2.7.egg (24.9 kB view details)

Uploaded Egg

File details

Details for the file Flask-Cors-3.0.3.tar.gz.

File metadata

  • Download URL: Flask-Cors-3.0.3.tar.gz
  • Upload date:
  • Size: 28.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Flask-Cors-3.0.3.tar.gz
Algorithm Hash digest
SHA256 62ebc5ad80dc21ca0ea9f57466c2c74e24a62274af890b391790c260eb7b754b
MD5 ddc12bdf8fa19a4ce1504ab9d0b0a8bc
BLAKE2b-256 64e8e6bcf79dcad7b7c10f8c8c35d78b5710f2ddcd8ed38e607dd6a4853ab8a8

See more details on using hashes here.

File details

Details for the file Flask_Cors-3.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Cors-3.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac4b81b3d90f5f18714c995c807f94501df8c9bbc22ef4261c1cd850748c3850
MD5 24828172b369cc1b5d3a91e5d4b9ca2a
BLAKE2b-256 83a7c7243ffd096a491013956c9ee71e2ed0b7d14979fafe89986ca2d30fc6f7

See more details on using hashes here.

File details

Details for the file Flask_Cors-3.0.3-py2.7.egg.

File metadata

  • Download URL: Flask_Cors-3.0.3-py2.7.egg
  • Upload date:
  • Size: 24.9 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Flask_Cors-3.0.3-py2.7.egg
Algorithm Hash digest
SHA256 55eb3864b4290f939ff19a2250fcb47d8c0f63d250c6780b922629299d011ec8
MD5 a2225c24089dd3e9ed2fbf92dfdf788a
BLAKE2b-256 54c47a3a006ebc26beaabbc27ae2d4a601bc45a651fbd67aa2036ad3afbb2add

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page