Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

plueprint

API Blueprint parser written in Python. It uses Markdown well-known package to do initial DOM parsing.

Installing

pip install plueprint

Using

As a library:

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.

About

API Blueprint Python parser

Resources

License

Packages

No packages published

Languages