From 40acc8092332dfed4bb54d7a4f89a6d479466de7 Mon Sep 17 00:00:00 2001 From: Cory Dolphin Date: Sun, 27 Aug 2023 15:10:47 -0700 Subject: [PATCH] Update CHANGELOG to reflect 4.0.0 release (#335) --- .github/workflows/unittests.yaml | 2 +- CHANGELOG.md | 4 ++++ README.rst | 26 +++++++++++++------------- 3 files changed, 18 insertions(+), 14 deletions(-) diff --git a/.github/workflows/unittests.yaml b/.github/workflows/unittests.yaml index 2b776a3..f1ab67c 100644 --- a/.github/workflows/unittests.yaml +++ b/.github/workflows/unittests.yaml @@ -1,4 +1,4 @@ -name: Python package +name: Python Unittests on: [push] diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b369d8..10da2de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log +## 4.0.0 +* Remove support for Python versions older than 3.8 by @WAKayser in https://github.com/corydolphin/flask-cors/pull/330 +* Add GHA tooling by @corydolphin in https://github.com/corydolphin/flask-cors/pull/331 + ## 3.1.01 * Include examples to specify that schema and port must be included in … by @YPCrumble in https://github.com/corydolphin/flask-cors/pull/294 * two small changes to the documentation, based on issue #290 by @bbbart in https://github.com/corydolphin/flask-cors/pull/291 diff --git a/README.rst b/README.rst index f90ac6c..091ef4c 100644 --- a/README.rst +++ b/README.rst @@ -6,10 +6,10 @@ Flask-CORS 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. +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. +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 @@ -24,14 +24,14 @@ Install the extension with using pip, or easy\_install. 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. +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. +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 `__. .. code:: python @@ -50,7 +50,7 @@ See the full list of options in the `documentation `__. .. code:: python @@ -65,8 +65,8 @@ See the full list of options in the `documentation `__. .. code:: python @@ -94,7 +94,7 @@ If things aren't working as you expect, enable logging to help understand what i Tests ----- -A simple set of tests is included in ``test/``. +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. If nosetests does not work for you, due to it no longer working with newer python versions. @@ -103,8 +103,8 @@ You can use pytest to run the tests instead. Contributing ------------ -Questions, comments or improvements? -Please create an issue on `Github `__, tweet at `@corydolphin `__ or send me an email. +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 @@ -112,7 +112,7 @@ Credits This Flask extension is based upon the `Decorator for the HTTP Access Control `__ written by Armin Ronacher. -.. |Build Status| image:: https://api.travis-ci.org/corydolphin/flask-cors.svg?branch=master +.. |Build Status| image:: https://github.com/corydolphin/flask-cors/actions/workflows/unittests.yaml/badge.svg :target: https://travis-ci.org/corydolphin/flask-cors .. |Latest Version| image:: https://img.shields.io/pypi/v/Flask-Cors.svg :target: https://pypi.python.org/pypi/Flask-Cors/