Skip to content

Commit 1803246

Browse files
committed
Initial restplus-> restx find & replace
Run regex replace to cover the following: Flask-RESTPlus -> Flask-RESTX Flask-RESTplus -> Flask-RESTX (there were a few typos) flask-restplus -> flask-restx restplus -> restx
1 parent 9232e1a commit 1803246

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+817
-817
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug Report
3-
about: Tell us how Flask-RESTPlus is broken
3+
about: Tell us how Flask-RESTX is broken
44
title: ''
55
labels: bug
66
assignees: ''
@@ -11,7 +11,7 @@ assignees: ''
1111

1212
- Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome.
1313
- Please check if a similar issue already exists or has been closed before. Seriously, nobody here is getting paid. Help us out and take five minutes to make sure you aren't submitting a duplicate.
14-
- Please review the [guidelines for contributing](https://github.com/noirbizarre/flask-restplus/blob/master/CONTRIBUTING.rst)
14+
- Please review the [guidelines for contributing](https://github.com/python-restx/flask-restx/blob/master/CONTRIBUTING.rst)
1515

1616
### **Code**
1717

@@ -36,7 +36,7 @@ If applicable, add the stack trace produced by the error
3636
### **Environment**
3737
- Python version
3838
- Flask version
39-
- Flask-RESTPlus version
39+
- Flask-RESTX version
4040
- Other installed Flask extensions
4141

4242
### **Additional Context**

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ _Put an `x` in the boxes that apply_
1515

1616
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
1717

18-
- [ ] I have read the [guidelines for contributing](https://github.com/noirbizarre/flask-restplus/blob/master/CONTRIBUTING.rst)
18+
- [ ] I have read the [guidelines for contributing](https://github.com/python-restx/flask-restx/blob/master/CONTRIBUTING.rst)
1919
- [ ] All unit tests pass on my local version with my changes
2020
- [ ] I have added tests that prove my fix is effective or that my feature works
2121
- [ ] I have added necessary documentation (if appropriate)

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ histograms/
6060
doc/_build/
6161

6262
# Specifics
63-
flask_restplus/static
63+
flask_restx/static
6464
node_modules

CONTRIBUTING.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Contributing
22
============
33

4-
flask-restplus is open-source and very open to contributions.
4+
flask-restx is open-source and very open to contributions.
55

66
If you're part of a corporation with an NDA, and you may require updating the license.
77
See Updating Copyright below
@@ -14,7 +14,7 @@ to submit reports on the `official bugtracker`_.
1414

1515
Provide as much informations as possible to specify the issues:
1616

17-
- the flask-restplus version used
17+
- the flask-restx version used
1818
- a stacktrace
1919
- installed applications list
2020
- a code sample to reproduce the issue
@@ -26,7 +26,7 @@ Submitting patches (bugfix, features, ...)
2626

2727
If you want to contribute some code:
2828

29-
1. fork the `official flask-restplus repository`_
29+
1. fork the `official flask-restx repository`_
3030
2. Ensure an issue is opened for your feature or bug
3131
3. create a branch with an explicit name (like ``my-new-feature`` or ``issue-XX``)
3232
4. do your work in it
@@ -44,7 +44,7 @@ There are some rules to follow:
4444
- your code should be mostly PEP8 compatible with a 120 characters line length
4545
- your contribution should support both Python 2 and 3 (use ``tox`` to test)
4646

47-
You need to install some dependencies to develop on flask-restplus:
47+
You need to install some dependencies to develop on flask-restx:
4848

4949
.. code-block:: console
5050
@@ -76,13 +76,13 @@ and ensure the documentation is generating.
7676
7777
$ tox
7878
79-
You also need to ensure your code is compliant with the flask-restplus coding standards:
79+
You also need to ensure your code is compliant with the flask-restx coding standards:
8080

8181
.. code-block:: console
8282
8383
$ inv qa
8484
85-
To ensure everything is fine before commiting, you can launch the all in one command:
85+
To ensure everything is fine before committing, you can launch the all in one command:
8686

8787
.. code-block:: console
8888
@@ -91,8 +91,8 @@ To ensure everything is fine before commiting, you can launch the all in one com
9191
It will ensure the code meet the coding conventions, runs on every version on python
9292
and the documentation is properly generating.
9393

94-
.. _official flask-restplus repository: https://github.com/noirbizarre/flask-restplus
95-
.. _official bugtracker: https://github.com/noirbizarre/flask-restplus/issues
94+
.. _official flask-restx repository: https://github.com/python-restx/flask-restx
95+
.. _official bugtracker: https://github.com/python-restx/flask-restx/issues
9696

9797
Running a local Swagger Server
9898
------------------------------

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
include README.rst CHANGELOG.rst MANIFEST.in LICENSE
2-
recursive-include flask_restplus *
2+
recursive-include flask_restx *
33
recursive-include requirements *.pip
44

55
global-exclude *.pyc

README.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,63 +2,63 @@
22
Flask RestPlus
33
==============
44

5-
.. image:: https://secure.travis-ci.org/noirbizarre/flask-restplus.svg?branch=master
6-
:target: https://travis-ci.org/noirbizarre/flask-restplus?branch=master
5+
.. image:: https://secure.travis-ci.org/python-restx/flask-restx.svg?branch=master
6+
:target: https://travis-ci.org/python-restx/flask-restx?branch=master
77
:alt: Build status
8-
.. image:: https://coveralls.io/repos/noirbizarre/flask-restplus/badge.svg?branch=master
9-
:target: https://coveralls.io/r/noirbizarre/flask-restplus?branch=master
8+
.. image:: https://coveralls.io/repos/python-restx/flask-restx/badge.svg?branch=master
9+
:target: https://coveralls.io/r/python-restx/flask-restx?branch=master
1010
:alt: Code coverage
11-
.. image:: https://readthedocs.org/projects/flask-restplus/badge/?version=latest
12-
:target: https://flask-restplus.readthedocs.io/en/latest/
11+
.. image:: https://readthedocs.org/projects/flask-restx/badge/?version=latest
12+
:target: https://flask-restx.readthedocs.io/en/latest/
1313
:alt: Documentation status
14-
.. image:: https://img.shields.io/pypi/l/flask-restplus.svg
15-
:target: https://pypi.org/project/flask-restplus
14+
.. image:: https://img.shields.io/pypi/l/flask-restx.svg
15+
:target: https://pypi.org/project/flask-restx
1616
:alt: License
17-
.. image:: https://img.shields.io/pypi/pyversions/flask-restplus.svg
18-
:target: https://pypi.org/project/flask-restplus
17+
.. image:: https://img.shields.io/pypi/pyversions/flask-restx.svg
18+
:target: https://pypi.org/project/flask-restx
1919
:alt: Supported Python versions
2020
.. image:: https://badges.gitter.im/Join%20Chat.svg
21-
:alt: Join the chat at https://gitter.im/noirbizarre/flask-restplus
22-
:target: https://gitter.im/noirbizarre/flask-restplus?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
21+
:alt: Join the chat at https://gitter.im/python-restx
22+
:target: https://gitter.im/python-restx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
2323

24-
Flask-RESTPlus is an extension for `Flask`_ that adds support for quickly building REST APIs.
25-
Flask-RESTPlus encourages best practices with minimal setup.
26-
If you are familiar with Flask, Flask-RESTPlus should be easy to pick up.
24+
Flask-RESTX is an extension for `Flask`_ that adds support for quickly building REST APIs.
25+
Flask-RESTX encourages best practices with minimal setup.
26+
If you are familiar with Flask, Flask-RESTX should be easy to pick up.
2727
It provides a coherent collection of decorators and tools to describe your API
2828
and expose its documentation properly using `Swagger`_.
2929

3030

3131
Compatibility
3232
=============
3333

34-
Flask-RestPlus requires Python 2.7 or 3.4+.
34+
Flask-RESTX requires Python 2.7 or 3.4+.
3535

3636

3737
Installation
3838
============
3939

40-
You can install Flask-Restplus with pip:
40+
You can install Flask-RESTX with pip:
4141

4242
.. code-block:: console
4343
44-
$ pip install flask-restplus
44+
$ pip install flask-restx
4545
4646
or with easy_install:
4747

4848
.. code-block:: console
4949
50-
$ easy_install flask-restplus
50+
$ easy_install flask-restx
5151
5252
5353
Quick start
5454
===========
5555

56-
With Flask-Restplus, you only import the api instance to route and document your endpoints.
56+
With Flask-RESTX, you only import the api instance to route and document your endpoints.
5757

5858
.. code-block:: python
5959
6060
from flask import Flask
61-
from flask_restplus import Api, Resource, fields
61+
from flask_restx import Api, Resource, fields
6262
6363
app = Flask(__name__)
6464
api = Api(app, version='1.0', title='TodoMVC API',
@@ -155,8 +155,8 @@ With Flask-Restplus, you only import the api instance to route and document your
155155
Contributors
156156
============
157157

158-
Flask-RESTPlus is brought to you by @noirbizarre. Since early 2019 @SteadBytes,
159-
@a-luna, @j5awry, @ziirish volunteered to help @noirbizarre keep the project up
158+
Flask-RESTX is brought to you by @python-restx. Since early 2019 @SteadBytes,
159+
@a-luna, @j5awry, @ziirish volunteered to help @python-restx keep the project up
160160
and running.
161161
Of course everyone is welcome to contribute and we will be happy to review your
162162
PR's or answer to your issues.
@@ -165,7 +165,7 @@ PR's or answer to your issues.
165165
Documentation
166166
=============
167167

168-
The documentation is hosted `on Read the Docs <http://flask-restplus.readthedocs.io/en/latest/>`_
168+
The documentation is hosted `on Read the Docs <http://flask-restx.readthedocs.io/en/latest/>`_
169169

170170

171171
.. _Flask: http://flask.pocoo.org/
@@ -174,4 +174,4 @@ The documentation is hosted `on Read the Docs <http://flask-restplus.readthedocs
174174

175175
Contribution
176176
============
177-
Want to contribute! That's awesome! Check out `CONTRIBUTING.rst! <https://github.com/noirbizarre/flask-restplus/blob/master/CONTRIBUTING.rst>`_
177+
Want to contribute! That's awesome! Check out `CONTRIBUTING.rst! <https://github.com/python-restx/flask-restx/blob/master/CONTRIBUTING.rst>`_

bumpr.rc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpr]
2-
file = flask_restplus/__about__.py
2+
file = flask_restx/__about__.py
33
vcs = git
44
commit = true
55
tag = true
@@ -26,7 +26,7 @@ bump = {version} ({date:%Y-%m-%d})
2626
prepare = Current
2727

2828
[readthedoc]
29-
id = flask-restplus
29+
id = flask-restx
3030

3131
[replace]
3232
dev = ?branch=master

coverage.rc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[run]
2-
source = flask_restplus
2+
source = flask_restx
33
branch = True
44
omit =
55
/tests/*

doc/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ qthelp:
8585
@echo
8686
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
8787
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask-RESTPlus.qhcp"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask-RESTX.qhcp"
8989
@echo "To view the help file:"
90-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask-RESTPlus.qhc"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask-RESTX.qhc"
9191

9292
devhelp:
9393
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
9494
@echo
9595
@echo "Build finished."
9696
@echo "To view the help file:"
97-
@echo "# mkdir -p $$HOME/.local/share/devhelp/Flask-RESTPlus"
98-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Flask-RESTPlus"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/Flask-RESTX"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Flask-RESTX"
9999
@echo "# devhelp"
100100

101101
epub:
File renamed without changes.
File renamed without changes.

doc/_themes/restplus/theme.conf renamed to doc/_themes/restx/theme.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[theme]
22
inherit = alabaster
3-
stylesheet = restplus.css
3+
stylesheet = restx.css
44

55
[options]
66
favicons=

doc/api.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
API
44
===
55

6-
.. currentmodule:: flask_restplus
6+
.. currentmodule:: flask_restx
77

88
Core
99
----
@@ -24,61 +24,61 @@ Core
2424
Models
2525
------
2626

27-
.. autoclass:: flask_restplus.Model
27+
.. autoclass:: flask_restx.Model
2828
:members:
2929

3030
All fields accept a ``required`` boolean and a ``description`` string in ``kwargs``.
3131

32-
.. automodule:: flask_restplus.fields
32+
.. automodule:: flask_restx.fields
3333
:members:
3434

3535

3636
Serialization
3737
-------------
38-
.. currentmodule:: flask_restplus
38+
.. currentmodule:: flask_restx
3939

4040
.. autofunction:: marshal
4141

4242
.. autofunction:: marshal_with
4343

4444
.. autofunction:: marshal_with_field
4545

46-
.. autoclass:: flask_restplus.mask.Mask
46+
.. autoclass:: flask_restx.mask.Mask
4747
:members:
4848

49-
.. autofunction:: flask_restplus.mask.apply
49+
.. autofunction:: flask_restx.mask.apply
5050

5151

5252
Request parsing
5353
---------------
5454

55-
.. automodule:: flask_restplus.reqparse
55+
.. automodule:: flask_restx.reqparse
5656
:members:
5757

5858
Inputs
5959
~~~~~~
6060

61-
.. automodule:: flask_restplus.inputs
61+
.. automodule:: flask_restx.inputs
6262
:members:
6363

6464

6565
Errors
6666
------
6767

68-
.. automodule:: flask_restplus.errors
68+
.. automodule:: flask_restx.errors
6969
:members:
7070

71-
.. autoexception:: flask_restplus.fields.MarshallingError
71+
.. autoexception:: flask_restx.fields.MarshallingError
7272

73-
.. autoexception:: flask_restplus.mask.MaskError
73+
.. autoexception:: flask_restx.mask.MaskError
7474

75-
.. autoexception:: flask_restplus.mask.ParseError
75+
.. autoexception:: flask_restx.mask.ParseError
7676

7777

7878
Schemas
7979
-------
8080

81-
.. automodule:: flask_restplus.schemas
81+
.. automodule:: flask_restx.schemas
8282
:members:
8383

8484

@@ -88,11 +88,11 @@ Internals
8888
These are internal classes or helpers.
8989
Most of the time you shouldn't have to deal directly with them.
9090

91-
.. autoclass:: flask_restplus.api.SwaggerView
91+
.. autoclass:: flask_restx.api.SwaggerView
9292

93-
.. autoclass:: flask_restplus.swagger.Swagger
93+
.. autoclass:: flask_restx.swagger.Swagger
9494

95-
.. autoclass:: flask_restplus.postman.PostmanCollectionV1
95+
.. autoclass:: flask_restx.postman.PostmanCollectionV1
9696

97-
.. automodule:: flask_restplus.utils
97+
.. automodule:: flask_restx.utils
9898
:members:

0 commit comments

Comments
 (0)