PyLink/docs/technical/README.md

# PyLink Developer Documentation

Please note that as PyLink is still in its development phase, its APIs are subject to change.
Any documentation here is provided for reference only.

The docs are also really incomplete (contributors welcome!)

## Introduction

PyLink is an a modular, plugin-based IRC services framework. It uses swappable protocol modules and a hooks system for calling plugins, allowing them to function regardless of the IRCd used.

<img src="core-structure.png" width="50%" height="50%">

## Contents

- [Writing plugins for PyLink](writing-plugins.md)
- [PyLink protocol module specification](pmodule-spec.md)
- [PyLink hooks reference](hooks-reference.md)
- [Supported named channel modes](channel-modes.csv)
- [API reference: utils.py](autogen/utils.html)
- [API reference: classes.py](autogen/classes.html)

### Future topics (not yet available)
- [Writing tests for PyLink modules](writing-tests.md)
- [Supported named user modes](user-modes.csv)
- [Services bot API/Creating your own service bots](services-api.md)
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00			`# PyLink Developer Documentation`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs: relayout table of contents & links between pages 2016-05-12 06:31:11 +02:00			`Please note that as PyLink is still in its development phase, its APIs are subject to change.`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00			`Any documentation here is provided for reference only.`

docs: relayout table of contents & links between pages 2016-05-12 06:31:11 +02:00			`The docs are also really incomplete (contributors welcome!)`
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-07 08:11:31 +02:00
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00			`## Introduction`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs: relayout table of contents & links between pages 2016-05-12 06:31:11 +02:00			`PyLink is an a modular, plugin-based IRC services framework. It uses swappable protocol modules and a hooks system for calling plugins, allowing them to function regardless of the IRCd used.`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs/: smaller image 2015-08-06 12:10:21 +02:00			`<img src="core-structure.png" width="50%" height="50%">`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00			`## Contents`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs/: fill in Contents, where future docs will go 2015-08-09 08:36:46 +02:00			`- [Writing plugins for PyLink](writing-plugins.md)`
			`- [PyLink protocol module specification](pmodule-spec.md)`
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-07 08:11:31 +02:00			`- [PyLink hooks reference](hooks-reference.md)`
docs: relayout table of contents & links between pages 2016-05-12 06:31:11 +02:00			`- [Supported named channel modes](channel-modes.csv)`
			`- [API reference: utils.py](autogen/utils.html)`
			`- [API reference: classes.py](autogen/classes.html)`
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00
			`### Future topics (not yet available)`
docs/: fill in Contents, where future docs will go 2015-08-09 08:36:46 +02:00			`- [Writing tests for PyLink modules](writing-tests.md)`
docs: relayout table of contents & links between pages 2016-05-12 06:31:11 +02:00			`- [Supported named user modes](user-modes.csv)`
docs: tweak writing-plugins & TOC, move plugin_example to plugins Closes #226. 2016-05-22 19:59:57 +02:00			`- [Services bot API/Creating your own service bots](services-api.md)`