File tree Expand file tree Collapse file tree 2 files changed +41
-2
lines changed Expand file tree Collapse file tree 2 files changed +41
-2
lines changed Original file line number Diff line number Diff line change 4
4
contain the root `toctree` directive.
5
5
6
6
Welcome to Flask-RESTX's documentation!
7
- ==========================================
7
+ =======================================
8
8
9
9
Flask-RESTX is an extension for Flask that adds support for quickly building REST APIs.
10
10
Flask-RESTX encourages best practices with minimal setup.
11
11
If you are familiar with Flask, Flask-RESTX should be easy to pick up.
12
12
It provides a coherent collection of decorators and tools to describe your API
13
13
and expose its documentation properly (using Swagger).
14
14
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
+
15
32
16
33
Compatibility
17
34
=============
18
35
19
- flask-restx requires Python 2.7+.
36
+ flask-restx requires Python 2.7+ or 3.4+ .
20
37
21
38
22
39
Installation
Original file line number Diff line number Diff line change @@ -10,6 +10,28 @@ and that you have already installed both Flask and Flask-RESTX.
10
10
If not, then follow the steps in the :ref: `installation ` section.
11
11
12
12
13
+ Migrate from Flask-RESTPlus
14
+ ---------------------------
15
+
16
+ .. warning :: The *migration* commands provided below are here for the illustration.
17
+ You may need to adapt them to properly fit your needs.
18
+ We also recommend you make a backup of your project prior running them.
19
+
20
+ At this point, Flask-RESTX remains 100% compatible with Flask-RESTPlus' API.
21
+ All you need to do is update your requirements to use Flask-RESTX instead of
22
+ Flask-RESTPlus. Then you need to update all your imports.
23
+ This can be done using something like:
24
+
25
+ ::
26
+ find . -type f -name "*.py" | xargs sed -i "s/flask_restplus/flask_restx/g"
27
+
28
+ Finally, you will need to update your configuration options (described `here
29
+ <quickstart.html#configuration> `_). Example:
30
+
31
+ ::
32
+ find . -type f -name "*.py" | xargs sed -i "s/RESTPLUS_/RESTX_/g"
33
+
34
+
13
35
Initialization
14
36
--------------
15
37
You can’t perform that action at this time.
0 commit comments