# plueprint
[API Blueprint](https://github.com/apiaryio/api-blueprint) parser written in Python.
It uses [Markdown](https://pythonhosted.org/Markdown) well-known package to do
initial DOM parsing.
### Installing
```
pip install plueprint
```
### Using
As a library:
```Python
from markdown import Markdown
m = Markdown(extensions=["plueprint"])
m.set_output_format("apiblueprint")
api = m.convert("""
FORMAT: 1A
# The Simplest API
This is one of the simplest APIs written in the **API Blueprint**.
# /message
## GET
+ Response 200 (text/plain)
Hello World!
""")
print(api)
```
As a script:
```
python -m plueprint "Real World API.md"
python -m plueprint "Real World API.md" -o "api.pickle"
```
### Notes
To suppress warnings about parsed documents, set `plueprint.entities.report_warnings` to `False`.
Released under New BSD license.
[API Blueprint](https://github.com/apiaryio/api-blueprint) parser written in Python.
It uses [Markdown](https://pythonhosted.org/Markdown) well-known package to do
initial DOM parsing.
### Installing
```
pip install plueprint
```
### Using
As a library:
```Python
from markdown import Markdown
m = Markdown(extensions=["plueprint"])
m.set_output_format("apiblueprint")
api = m.convert("""
FORMAT: 1A
# The Simplest API
This is one of the simplest APIs written in the **API Blueprint**.
# /message
## GET
+ Response 200 (text/plain)
Hello World!
""")
print(api)
```
As a script:
```
python -m plueprint "Real World API.md"
python -m plueprint "Real World API.md" -o "api.pickle"
```
### Notes
To suppress warnings about parsed documents, set `plueprint.entities.report_warnings` to `False`.
Released under New BSD license.
1 maintainer
Metadata
1 maintainer
Release files for plueprint 0.4.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 | |
|---|---|---|---|
| plueprint-0.4.2.tar.gz | 16.2 kB | Details |
Release files / plueprint-0.4.2.tar.gz
| Download URL | plueprint-0.4.2.tar.gz |
|---|---|
| Size | 16.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d157e7d2e8e08df3b56a000f705e4b87093298bf27fb8cc454152fb1d2057ff
|
|
BLAKE2b-256 checksum How to use checksums |
ff144b8c0fa64169584b1ea7b7f4d023bbeb662b3cf64b71c57d7e675615597f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
