File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 44 contain the root `toctree` directive.
55
66 Welcome to Flask-RESTX's documentation!
7- ==========================================
7+ =======================================
88
99Flask-RESTX is an extension for Flask that adds support for quickly building REST APIs.
1010Flask-RESTX encourages best practices with minimal setup.
1111If you are familiar with Flask, Flask-RESTX should be easy to pick up.
1212It provides a coherent collection of decorators and tools to describe your API
1313and expose its documentation properly (using Swagger).
1414
15+ Flask-RESTX is a community driven fork of `Flask-RESTPlus
16+ <https://github.com/noirbizarre/flask-restplus> `_
17+
18+
19+ Why did we fork?
20+ ================
21+
22+ The community has decided to fork the project due to lack of response from the
23+ original author @noirbizarre. We have been discussing this eventuality for
24+ `a long time <https://github.com/noirbizarre/flask-restplus/issues/593 >`_.
25+
26+ Things evolved a bit since that discussion and a few of us have been granted
27+ maintainers access to the github project, but only the original author has
28+ access rights on the PyPi project. As such, we been unable to make any actual
29+ releases. To prevent this project from dying out, we have forked it to continue
30+ development and to support our users.
31+
1532
1633Compatibility
1734=============
1835
19- flask-restx requires Python 2.7+.
36+ flask-restx requires Python 2.7+ or 3.4+ .
2037
2138
2239Installation
Original file line number Diff line number Diff line change @@ -10,6 +10,29 @@ and that you have already installed both Flask and Flask-RESTX.
1010If not, then follow the steps in the :ref: `installation ` section.
1111
1212
13+ Migrate from Flask-RESTPlus
14+ ---------------------------
15+
16+ .. warning :: The *migration* commands provided below are for illustration
17+ purposes.
18+ You may need to adapt them to properly fit your needs.
19+ We also recommend you make a backup of your project prior running them.
20+
21+ At this point, Flask-RESTX remains 100% compatible with Flask-RESTPlus' API.
22+ All you need to do is update your requirements to use Flask-RESTX instead of
23+ Flask-RESTPlus. Then you need to update all your imports.
24+ This can be done using something like:
25+
26+ ::
27+ find . -type f -name "*.py" | xargs sed -i "s/flask_restplus/flask_restx/g"
28+
29+ Finally, you will need to update your configuration options (described `here
30+ <quickstart.html#configuration> `_). Example:
31+
32+ ::
33+ find . -type f -name "*.py" | xargs sed -i "s/RESTPLUS_/RESTX_/g"
34+
35+
1336Initialization
1437--------------
1538
You can’t perform that action at this time.
0 commit comments