GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 01:09:22 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
1,037 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
19f1ee1be8
Go to file
James Lu 19f1ee1be8 p10: initial protocol stub (#87) 
This can connect and spawn the main PyLink client right now... It can't do anything else
2016-04-10 20:24:58 -07:00
docs docs/t: add channel-modes.csv (#200) 2016-04-09 18:30:43 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins Move rehash into core (Closes #178) 2016-04-09 09:54:04 -07:00
protocols p10: initial protocol stub (#87) 2016-04-10 20:24:58 -07:00
tests Use more flexible shebangs (/usr/bin/env python3) 2016-04-01 18:22:02 -07:00
.gitignore gitignore: Ignore env folder for virtualenvs 2016-03-29 19:52:57 +10:00
.mailmap Add .mailmap 2016-03-17 15:08:41 -07:00
AUTHORS AUTHORS: add @DanielOaks 2016-04-07 19:05:41 -07:00
classes.py Move getSid/getUid into classes.Protocol 2016-04-10 19:00:44 -07:00
conf.py conf: fix testconf missing the logging: section 2016-03-11 23:14:16 -08:00
coreplugin.py coreplugin: modularize rehash, and add a SIGHUP handler for it 2016-04-09 10:08:32 -07:00
example-conf.yml Let's use a default pingfreq value that makes sense... 2016-04-07 18:45:42 -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 log: respect child loggers' levels if they are lower than the main one's 2016-03-25 15:45:26 -07:00
pylink Use more flexible shebangs (/usr/bin/env python3) 2016-04-01 18:22:02 -07:00
README.md README: update supported ircds 2016-04-08 23:00:39 -07:00
runtests runtests: remove .py extension, only run tests when ran as a script 2016-03-11 23:14:16 -08:00
start-cpulimit.sh start-cpulimit: pass command line options to ./pylink 2015-09-25 20:25:07 -07:00
utils.py utils: add a simple P10 UID generator (#87) 2016-04-05 18:45:00 -07:00
world.py world: use a better module description 2016-03-11 23:14:16 -08: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.

Support

Please report any bugs you find to the issue tracker. Pull requests are open if you’d like to contribute, though new stuff generally goes to the devel branch.

You can also find support via our IRC channels: #PyLink @ irc.overdrivenetworks.com(webchat) or #PyLink @ chat.freenode.net. Ask your questions and be patient for a response.

Dependencies

  • Python 3.4+
  • PyYAML (pip install pyyaml)
  • For the servprotect plugin: expiringdict (note: unfortunately, installation is broken in pip due to mailgun/expiringdict#13)
  • For the changehost and opercmds plugins: ircmatch (pip install ircmatch)

Supported IRCds

Primary support

These IRCds are frequently tested and well supported. If any issues occur, please file a bug on the issue tracker.

  • charybdis (3.5.x / git master) - module ts6
  • InspIRCd 2.0.x - module inspircd
  • UnrealIRCd 4.x - module unreal
    • Note: Support for mixed UnrealIRCd 3.2/4.0 networks is experimental, and requires you to enable a mixed_link option in the configuration. This may in turn void your support.

Extended support

Support for these IRCds exist, but are not tested as frequently and thoroughly. Bugs should be filed if there are any issues, though they may not be always be fixed in a timely fashion.

  • Elemental-IRCd (6.6.x / git master) - module ts6
  • InspIRCd 2.2 (git master) - module inspircd
  • IRCd-Hybrid (8.2.x / svn trunk) - module hybrid
    • Note: for host changing support and optimal functionality, a service{} block / U-line should be added for PyLink on every IRCd across your network.

Setup

  1. Rename example-conf.yml 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???