Metadata-Version: 2.1
Name: docspec
Version: 0.2.0
Summary: Docspec is a JSON object specification for representing API documentation of programming languages.
Author: Niklas Rosenstein
Author-email: rosensteinniklas@gmail.com
License: MIT
Description-Content-Type: text/markdown
Requires-Dist: nr.databind.core<0.1.0,>=0.0.19
Requires-Dist: nr.databind.json<0.1.0,>=0.0.9

# docspec

This Python packages provides

* A library to (de-) serialize Docspec conformat JSON payloads
* A CLI to validate and introspect such payloads

Example:

```py
import docspec, sys
for module in docspec.load_modules(sys.stdin):
  module.members = [member for member in module.members if member.docstring]
  docspec.dump_module(sys.stdout)
```

```
$ docspec module.json --dump-tree
module docspec
| class Location
| | data filename
| | data lineno
| class Decoration
| | data name
# ...
```

The `docspec` Python module requires Python 3.5 or newer.

---

<p align="center">Copyright &copy; 2020, Niklas Rosenstein</p>
