Python OpenAPI Specification generator
Tool for automated or semi-automated generate a OpenAPI Specification (aka Swagger Specification) for Web APIs written with Python and famous frameworks, such as:
Django REST Framework (DRF>=2; Django>=1.6)
Falcon (falcon>=0.3)
flask
bottle
and ever you own framework
Supported only v2 OpenAPI Specification
Why?
This tool is written as part of our Documentation Toolkit which we use in our job daily. The main idea of toolkit is to make a process of creating and updating documentation able to be automated
Other parts of our toolkit is:
Install
Install from PyPI with
$ pip install py2swagger
Usage
usage: py2swagger [-h] [-c CONFIG] [-r ROOT] [-o OUTPUT]
{falcon,drf,simple} ...
Swagger schema builder
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
Path to config file
-r ROOT, --root ROOT Path to project root. Default is current directory or
configuration file location
-o OUTPUT, --output OUTPUT
Output file (Default stdout)
plugins:
{falcon,drf,simple}
falcon
drf
simple Plugin for all applications
Run tests
python setup.py test
Release files for py2swagger 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| py2swagger-1.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Release files / py2swagger-1.0.0-py2.py3-none-any.whl
| Download URL | py2swagger-1.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 28.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
5a2e1316dfb1898b119964bdf12df61daa29b37a6421f1a089a5f7656e805789
|
|
BLAKE2b-256 checksum How to use checksums |
79f04766900d9e1d2d51bb3de097984294ded6fd0bdd0a728a8ca49be4ea5a68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
