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
1,664 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
1b747bf09d
Go to file
James Lu 1b747bf09d relay_clientbot: skip relaying non-PRIVMSGs for X seconds after connect 
This can be configured via the option relay::clientbot_startup_delay, and defaults to 5 seconds.
2016-08-08 22:20:31 -07:00
coremods Merge branch 'master' into devel 2016-08-04 10:29:17 -07:00
docs hooks-reference: update keys for SJOIN 2016-08-08 21:06:49 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay_clientbot: skip relaying non-PRIVMSGs for X seconds after connect 2016-08-08 22:20:31 -07:00
protocols Move handle_error() to the generic protocol 2016-08-08 18:12:07 -07:00
.codeclimate.yml Add .codeclimate.yml 2016-06-08 07:56:10 -07:00
.gitignore Make plugins/ and protocols/ namespaces 2016-07-20 23:55:26 -07: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 Protocol: return a mapping of channels->lists of nicks in SQUIT payloads 2016-08-08 20:58:34 -07:00
conf.py Make server config validation protocol specific 2016-07-28 21:34:00 -07:00
example-conf.yml example-conf: mention relay_clientbot 2016-08-07 22:08:44 -07:00
LICENSE.CC-BY-SA-4.0 Relicense docs under CC-BY-SA-4.0 2016-07-09 00:14:24 -07:00
LICENSE.MPL2 Relicense docs under CC-BY-SA-4.0 2016-07-09 00:14:24 -07:00
log.py log: remove references to script directory 2016-06-20 18:23:05 -07:00
pylink pylink: show a better error if the protocol module is missing 2016-07-28 21:33:13 -07:00
README.md README: add inspircd 2.2 link, update juno version 2016-07-29 19:52:07 -07:00
RELNOTES.md Release 0.9.1 2016-08-06 20:00:57 -07:00
setup.py setup: refresh classifiers 2016-08-04 00:27:50 -07:00
structures.py Move DataStore to structures (untested) 2016-05-14 14:53:19 -07:00
update.sh update.sh: pass arguments to pylink 2016-07-16 21:58:39 -07:00
utils.py ServiceBot: use newline-agnostic str.splitlines() to split up docstrings 2016-08-02 12:38:15 -07:00
VERSION Bump version to 0.10-dev2 2016-08-02 23:59:55 -07:00
world.py core: rename IrcUser.identified attribute to IrcUser.account 2016-07-29 20:16:05 -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.

Support

First, MAKE SURE you’ve read the FAQ!

When upgrading between major versions, remember to read the release notes for any breaking changes!

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.

License

PyLink and any bundled software are licensed under the Mozilla Public License, version 2.0 (LICENSE.MPL2). The corresponding documentation in the docs/ folder is licensed under the Creative Attribution-ShareAlike 4.0 International License. (LICENSE.CC-BY-SA-4.0)

Dependencies

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

Supported IRCds

Primary support

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

  • charybdis (3.5+ / git master) - module ts6
  • InspIRCd 2.0.x - module inspircd
  • UnrealIRCd 4.x - module unreal
    • Linking to UnrealIRCd 3.2 servers is only supported when using an UnrealIRCd 4.x server as a hub, with topology such as pylink<->unreal4<->unreal3.2

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 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.
  • juno-ircd (11.x / janet) - module ts6 (with elemental-ircd modes)
  • Nefarious IRCu (2.0.0+) - module nefarious
    • Note: Both account cloaks (user and oper) and hashed IP cloaks are optionally supported (HOST_HIDING_STYLE settings 0 to 3). Make sure you configure PyLink to match your IRCd settings.
    • For optimal functionality (mode overrides in relay, etc.), a UWorld{} block / U-line should be added for every server that PyLink spawns.

Other TS6 and P10 variations may work, but are not officially supported.

Setup

  1. Install PyLink by using python3 setup.py install (global install) or python3 setup.py install --user (local install; note: --user is a literal string)

  2. Rename example-conf.yml to pylink.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!

  3. Run pylink from the command line.

  4. Profit???