Metadata-Version: 2.1
Name: docspec
Version: 2.0.0a1
Summary: Docspec is a JSON object specification for representing API documentation of programming languages.
Home-page: https://github.com/NiklasRosenstein/docspec/
License: MIT
Author: Niklas Rosenstein
Author-email: rosensteinniklas@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: Deprecated (>=1.2.12,<2.0.0)
Requires-Dist: databind.core (>=1.0.0,<2.0.0)
Requires-Dist: databind.json (>=1.0.0,<2.0.0)
Description-Content-Type: text/markdown

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

