GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 12:12:53 +01:00
Code Issues Projects Releases Wiki Activity
6a2a6a769f
PyLink/docs/technical
History
James Lu 16ac91a718 Merge the long-awaited 2.0 branch into master 
Merge branch 'devel'

Conflicts:
	RELNOTES.md
	VERSION
	classes.py
	conf.py
	coremods/control.py
	coremods/corecommands.py
	coremods/service_support.py
	docs/advanced-relay-config.md
	docs/faq.md
	example-conf.yml
	launcher.py
	plugins/global.py
	plugins/relay.py
	plugins/relay_clientbot.py
	protocols/p10.py
	utils.py
2018-07-11 22:45:52 -07:00
..
doxygen.conf Doxygen configuration & autorun script 2016-07-23 19:42:17 -07:00
doxygen.sh Doxygen configuration & autorun script 2016-07-23 19:42:17 -07:00
hooks-reference.md Merge the long-awaited 2.0 branch into master 2018-07-11 22:45:52 -07:00
permissions-api.md Update GitHub repository address 2018-07-08 12:54:10 -07:00
pmodule-spec.md Merge the long-awaited 2.0 branch into master 2018-07-11 22:45:52 -07:00
protocol-modules.dot Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
protocol-modules.svg Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
README.md Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
release-process.md Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
services-api.md services-api: less awkward wording 2018-07-02 00:59:29 -07:00
using-ircparser.md using-ircparser.md: minor tweaks and reordering 2017-03-12 20:45:42 -07:00
writing-plugins.md Merge the long-awaited 2.0 branch into master 2018-07-11 22:45:52 -07:00

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

Graph of protocol module inheritance tree