flake8-flask-openapi-docstring
This Flake8 plugin will check if your Flask route's docstrings are valid OpenAPI spec.
Libraries like APISpec can generate OpenAPI spec from your Flask routes and docstrings and it's important to have present and in the correct format.
for example, this routes:
@app.route("/hello", methods=["GET"])
def hello():
return "Hello World!"
will raise an error witht his plugin because not only the docstring is missing but also the OpenAPI spec is missing as well.
However these route:
@app.route("/hello", methods=["GET"])
def hello():
"""
Returns a greeting
---
get:
responses:
200:
"""
return "Hello World!"
will not raise any error because the docstring is present and the OpenAPI spec is present as well.
1 maintainer
Metadata
1 maintainer
Release files for flake8-flask-openapi-docstring 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| flake8_flask_openapi_docstring-0.1.2.tar.gz | 4.0 kB | Without provenance | Details for flake8_flask_openapi_docstring-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| flake8_flask_openapi_docstring-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for flake8_flask_openapi_docstring-0.1.2-py3-none-any.whl |
Total release size: 9.1 kB
Release files / flake8_flask_openapi_docstring-0.1.2.tar.gz
| Download URL | flake8_flask_openapi_docstring-0.1.2.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2c8c68271c48a56905956abd18a99b967bd5e88431252ad0251bbeda28483e6
|
|
BLAKE2b-256 checksum How to use checksums |
8eac00d35e5e3f21608a5bc7e32b982fb7a9153e9045137b55f14eaed52f9514
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.1
|
Release files / flake8_flask_openapi_docstring-0.1.2-py3-none-any.whl
| Download URL | flake8_flask_openapi_docstring-0.1.2-py3-none-any.whl |
|---|---|
| Size | 5.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1899695080ec0f4785b5794acc92de849d8ce462d885ccb111b8cb54aa069e5e
|
|
BLAKE2b-256 checksum How to use checksums |
52c611dd2a2b07e5f253ad85920032f9acd68c8279b960be60bf26dedef0e7ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.1
|
Security for flake8-flask-openapi-docstring 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
