GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-27 21:19:31 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
942 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
e70dfb0811
Go to file
James Lu e70dfb0811 Merge branch 'master' into devel
2016-03-26 17:58:18 -07:00
docs/technical Regenerate pydoc documentation 2016-03-26 11:42:12 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: fix ambiguous logging in KICK blocking 2016-03-26 17:56:11 -07:00
protocols inspircd: define minimum & target protocol versions instead of hardcoding them 2016-03-26 16:23:22 -07:00
tests Remove references to overdrive TLDs in code 2016-01-17 21:07:51 -08:00
.gitignore Rename config.yml.example -> example-conf.yml 2016-01-03 20:02:23 -08:00
.mailmap Add .mailmap 2016-03-17 15:08:41 -07:00
AUTHORS Add authors file 2016-01-03 10:05:30 -08:00
classes.py core: Store opertype info in all IrcUser objects 2016-03-26 12:55:23 -07:00
conf.py conf: fix testconf missing the logging: section 2016-03-11 23:14:16 -08:00
coreplugin.py coreplugin: sync opertype changes in handle_operup 2016-03-26 13:14:01 -07:00
example-conf.yml example conf: use 1 "#" without trailing space for commented-out options 2016-01-30 23:37:01 -08: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 pylink: prettier "Loaded plugins" log message on start 2016-03-26 16:29:17 -07:00
README.md New servprotect plugin (anti-KILL/SAVE flood) 2016-03-25 16:51:02 -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 Merge branch 'master' into devel 2016-03-26 17:58:18 -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: python3-expiringdict (apt-get install python3-expiringdict; not available in pip)
  • For the changehost and opercmds plugins: ircmatch (pip install ircmatch)

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
  • UnrealIRCd 4.x - module unreal (NOT Unreal 3.2 or lower)

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???