GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-28 13:42:37 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
709 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
2ddb72f9ec
Go to file
James Lu 2ddb72f9ec unreal: add incoming/outgoing INVITE support
2015-11-15 21:00:51 -08:00
docs/technical Doc updates: +using-utils.md stub; update autogenerated references for protocols/inspircd, utils 2015-10-03 16:39:52 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins Don't crash when REHASH loads a config file that's invalid 2015-11-11 18:55:51 -08:00
protocols unreal: add incoming/outgoing INVITE support 2015-11-15 21:00:51 -08:00
tests world: rename command_hooks=>hooks, bot_commands=>commands 2015-09-27 10:53:25 -07:00
.gitignore .gitignore: ignore .pem files 2015-08-10 20:26:10 -07:00
classes.py classes: log offending hook data when a hook function errors 2015-11-08 10:56:09 -08:00
conf.py Don't crash when REHASH loads a config file that's invalid 2015-11-11 18:55:51 -08:00
config.yml.example Irc: require autoconnect value to be >= 1 2015-10-02 23:21:40 -07:00
coreplugin.py coreplugin: log plugin loading/unloading to INFO 2015-10-25 10:39:47 -07:00
kill.sh Add wrapper scripts (start-cpulimit.sh, kill.sh) to assist running PyLink under cpulimit 2015-07-25 16:58:11 -07:00
LICENSE Add a LICENSE: MPL 2.0 2015-06-20 21:10:50 -07:00
log.py Support loading different config files from the command line 2015-08-03 19:27:19 -07:00
pylink Modularize our import hacks, make Irc() take a conf object again 2015-09-28 19:12:45 -07:00
README.md README: update our goals 2015-10-09 23:11:15 -07:00
runtests.py runtests: allow specifying files to test 2015-09-12 22:31:19 -07:00
start-cpulimit.sh start-cpulimit: pass command line options to ./pylink 2015-09-25 20:25:07 -07:00
utils.py utils: return the bound function in add_cmd/add_hook 2015-10-23 18:47:11 -07:00
world.py Modularize our import hacks, make Irc() take a conf object again 2015-09-28 19:12:45 -07:00

README.md

PyLink

PyLink is an extensible, plugin-based IRC Services framework written in Python. It aims to be 1) a replacement for the now-defunct Janus 2) a versatile framework and gateway to IRC.

Usage

PyLink is a work in progress and thus may be very unstable! No warranty is provided if this completely wrecks your network and causes widespread rioting amongst your users!

That said, please report any bugs you find to the issue tracker. Pull requests are open if you’d like to contribute: note that master is bugfix only; new stuff goes to the devel branch.

You can also find support via our IRC channel: #PyLink at irc.overdrive.pw (webchat). Ask your question and be patient.

Dependencies

Dependencies currently include:

  • Python 3.4+
  • PyYAML (pip install pyyaml or apt-get install python3-yaml)
  • For the relay plugin only: expiringdict (pip install expiringdict/apt-get install python3-expiringdict)

Supported IRCds

  • InspIRCd 2.0.x - module inspircd
  • charybdis (3.5.x / git master) - module ts6
  • Elemental-IRCd (6.6.x / git master) - module ts6

Setup

  1. Rename config.yml.example to config.yml and configure your instance there. Note that the configuration format isn’t finalized yet - this means that your configuration may break in an update!

  2. Run ./pylink from the command line.

  3. Profit???