Metadata-Version: 2.1
Name: earendil
Version: 0.1
Summary: machine-readable IRC protocol specification
Home-page: https://github.com/agrif/earendil/
Author: Aaron Griffith
Author-email: aargri@gmail.com
License: MIT
Project-URL: Source, https://github.com/agrif/earendil/
Project-URL: Documentation, https://earendil-irc.readthedocs.io/en/latest/
Keywords: irc specification
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: lark-parser (>=0.8.0)
Requires-Dist: jinja2 (>=2.10.0)
Requires-Dist: markdown (>=3.2.0)
Provides-Extra: docs
Requires-Dist: mkdocs (>=1.0) ; extra == 'docs'
Requires-Dist: mkautodoc (>=0.1.0) ; extra == 'docs'

# earendil

<[![PyPI](https://img.shields.io/pypi/v/earendil)](https://pypi.org/project/earendil/)
[![Travis CI](https://img.shields.io/travis/com/agrif/earendil/master)](https://travis-ci.com/agrif/earendil)
[![Read the Docs](https://img.shields.io/readthedocs/earendil-irc/latest)][docs]

 [docs]: https://earendil-irc.readthedocs.io/en/latest/

This is the beginnings of a Python irc bot framework. But that's not
the interesting part.

The interesting part is in `earendil/ircdef/messages.desc`, which is a
human-readable description of the IRC protocol. Using
```{.bash}
python3 -m earendil.ircdef
```
you can compile this description into a machine-readable JSON
description and a hyperlinked documentation website.


