Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryu-cz/restx-monkey
Monkey patches for unmaintained flask-restx
https://github.com/ryu-cz/restx-monkey
api flask flask-restx json openapi python rest restful restplus restx swagger
Last synced: 3 months ago
JSON representation
Monkey patches for unmaintained flask-restx
- Host: GitHub
- URL: https://github.com/ryu-cz/restx-monkey
- Owner: Ryu-CZ
- License: bsd-3-clause
- Created: 2022-08-26T06:52:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-13T09:07:03.000Z (over 1 year ago)
- Last Synced: 2024-11-06T01:50:29.770Z (3 months ago)
- Topics: api, flask, flask-restx, json, openapi, python, rest, restful, restplus, restx, swagger
- Language: Python
- Homepage:
- Size: 3.78 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Restx-Monkey
[](https://codecov.io/gh/Ryu-CZ/restx-monkey)
Monkey patches for unmaintained [flask-restx](https://github.com/python-restx/flask-restx) python package to keep
your installation of flask-restx compatible with the latest [flask](https://github.com/pallets/flask)
and [werkzeug](https://github.com/pallets/werkzeug).
**Good NEWS everyone!** Package [flask-restx](https://github.com/python-restx/flask-restx) is maintained now! I strongly suggest to submit issues on official project [issues page](https://github.com/python-restx/flask-restx/issues).
## Installation
To install restx_monkey, use [pip](https://pip.pypa.io/en/stable/):
```shell
python -m pip install -U restx-monkey
```
## Usage
Before importing `flask-restx` apply all patches in your main module:
```python
# app main file
import restx_monkey as monkey
monkey.patch_restx()
# after patch import other modules
import flask_restx
# your other code
```
or select which patches you do not want to apply
```python
# app main file
import restx_monkey as monkey
monkey.patch_restx(fix_restx_api=False)
# after patch import other modules
import flask_restx
# your other code
```
### What is patched?
Here is list of patches applied to [flask-restx](https://github.com/python-restx/flask-restx) package by this monkey:
- _replace_parse_rule_ - injects `parse_rule` method into werkzeug because `flask-restx` is using this internal method
- _fix_restx_api_ - fix deprecated `flask-restx.api.Api` init of `doc` endpoints after blueprint is bound
- _fix_restx_parser_ - replace failing `flask_restx.reqparse.Argument` class with child whom can correctly handle `json`
location of argument in `flask.Request` even in HTTP `GET` callback
- _update_swagger_ui_ - replace content of `flask_restx.static` directory with the later swagger UI then restx < 1.0
- _fix_endpoint_from_view_ - fix `flask.scaffold` missing `_endpoint_from_view_func`
- _inject_versions_ - puts back `__version__` to `flask` and `werkzeug` for `3.0+` where the version was removed
## Goal of project
Keep [flask-restx](https://github.com/python-restx/flask-restx) compatible with the
latest [flask](https://github.com/pallets/flask) and [werkzeug](https://github.com/pallets/werkzeug) as long as it is
reasonable simple to monkey patch it.
### What this project is not
This project does not solve incompatibilities of other python packages
using [flask-restx](https://github.com/python-restx/flask-restx).
## Tests
You can run tests with coverage tracing:
```shell
python -m coverage run -m unittest tests/test_* -v
```
To generate coverage report:
```shell
python -m coverage html
```
## Build
Clone repo and set up your pypi repo account credentials on build for build environment.
- Move to package repo:
```shell
cd ~/git/restx_monkey
```
- Install requirements:
```shell
python -m pip install -Ur requirements.txt
```
- Clean old build fragments:
```shell
rm -rf ./dist ./build ./src/restx_monkey.egg-info
```
- Build new package:
```shell
python -m build
```
- Upload new package:
```shell
python -m twine upload dist/*
```