https://github.com/vmarkovtsev/plueprint

API Blueprint Python parser
https://github.com/vmarkovtsev/plueprint

Last synced: 22 days ago
JSON representation

API Blueprint Python parser

• Host: GitHub
• URL: https://github.com/vmarkovtsev/plueprint
• Owner: vmarkovtsev
• License: bsd-3-clause
• Created: 2015-10-27T15:29:00.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-23T04:43:02.000Z (over 8 years ago)
• Last Synced: 2024-09-28T19:04:50.135Z (about 1 month ago)
• Language: Python
• Size: 34.2 KB
• Stars: 25
• Watchers: 2
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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