PyLink/docs/technical/README.md

PyLink Developer Documentation

This documentation is provided for reference only, and may not always be up to date as APIs change. Patches are welcome if something looks wrong or is wrong. In such cases, consulting the source code is probably your best bet.

The docs are also really incomplete (contributions are appreciated!)

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.

Contents

• Writing plugins for PyLink
• PyLink hooks reference
• Services bot API/Creating your own service bots
• Permissions API Introduction
• Using utils.IRCParser()

---

• PyLink protocol module specification

---

• Release Process for PyLink

Graph of protocol module inheritance tree