Skip to main content

API Blueprint (https://apiblueprint.org/) parser in pure Python

Project description

# 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plueprint-0.4.2.tar.gz (16.2 kB view details)

Uploaded Source

File details

Details for the file plueprint-0.4.2.tar.gz.

File metadata

  • Download URL: plueprint-0.4.2.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for plueprint-0.4.2.tar.gz
Algorithm Hash digest
SHA256 3d157e7d2e8e08df3b56a000f705e4b87093298bf27fb8cc454152fb1d2057ff
MD5 0c4d20fe38772e0d2d06d9a33598a80a
BLAKE2b-256 ff144b8c0fa64169584b1ea7b7f4d023bbeb662b3cf64b71c57d7e675615597f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page