3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-23 19:19:31 +01:00
Go to file
James Lu 1d6da68963 Add Travis CI configuration
Squashed commit of the following:

commit b03e5f82405343d54015a40c1655d54f0fc5ce90
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 16:04:51 2017 -0700

    .travis: install pandoc, disable docs and email

commit 25cd4ad2a07686f7a196b151070efe3fd31a94e3
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:55:36 2017 -0700

    wrap python as a subprocess

commit 749177ac7b13921f8a04b023b54c1716ff0ce0b0
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:53:37 2017 -0700

    oops, do proper matching

commit 98f90c15fd5be91b70ecf70bdff3a005d1fedc94
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:52:15 2017 -0700

    i am not dealing with this shell.

commit 8b3dcb6c59617e7ca85363bf485dc295ff22a012
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:37:28 2017 -0700

    More .travis.yml tweaks

commit 49346bef1b7794eefd251d27e846a184c0569dad
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:28:30 2017 -0700

    .travis.yml: add missing directory to compileall

commit 7eb1d464481c958ef007b51234045a13f1a8c06e
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:23:21 2017 -0700

    Make travis do syntax verification on all modules

commit 0331356e91e22cd85859a4ebbaf1973f21db1650
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Mon Mar 27 15:19:24 2017 -0700

    Revert ".travis.yml: remove duplicate python version restriction"

    This reverts commit 51c74cedff78aa204813743e1a738e3aa63fe3c6.

commit 51c74cedff78aa204813743e1a738e3aa63fe3c6
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Wed Feb 22 16:23:14 2017 -0800

    .travis.yml: remove duplicate python version restriction

commit 04087af09a29e2f825545cdc36be55f86a7c7d10
Author: James Lu <GLolol@overdrivenetworks.com>
Date:   Wed Feb 22 16:07:51 2017 -0800

    Test travis-ci deployment
2017-03-27 16:13:05 -07:00
coremods corecommands: remove extraneous irc.checkAuthenticated() call 2017-02-24 17:50:20 -08:00
docs services-api.md: remove extra_channels argument per d31d09ce7e 2017-01-22 00:55:37 -08:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: less ambiguous error if a relay channel doesn't exist on the caller network 2017-02-22 15:42:52 -08:00
protocols nefarious: fix a typo causing crash on user mode change 2017-02-17 22:28:11 -08:00
.codeclimate.yml Add .codeclimate.yml 2016-06-08 07:56:10 -07:00
.gitattributes Actually, use LF line endings for everything 2016-10-27 18:43:57 -07:00
.gitignore Make plugins/ and protocols/ namespaces 2016-07-20 23:55:26 -07:00
.mailmap update mailmap with my (IotaSpencer) aliases 2016-11-22 22:52:05 -08:00
.travis.yml Add Travis CI configuration 2017-03-27 16:13:05 -07:00
AUTHORS AUTHORS: add @IotaSpencer and update my email 2016-11-18 23:16:50 -08:00
classes.py Irc: simplify runloop error catching, adding RuntimeError and SystemExit (closes #438) 2017-03-26 14:46:51 -07:00
conf.py core: update "missing dependencies" errors 2016-12-09 17:15:53 -08:00
example-conf.yml example-conf: make the "permissions:" block migration note more prominent 2017-02-19 21:40:00 -08:00
example-permissions.yml docs: reorganize & include a list of all PyLink permissions 2016-12-25 00:41:41 -08: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 core: update stdout log level on REHASH 2017-01-07 00:12:35 -08:00
pylink launcher: disable pid check by default 2016-12-16 20:55:09 -08:00
pylink-contribdl pylink-contribdl: link to contrib modules list if no argument is given 2016-12-05 00:45:53 -08:00
pylink-mkpasswd -mkpasswd: fetch password via getpass instead of requiring command line entry 2017-01-29 00:12:05 -08:00
README.md README: move Apt / PPA instructions to after source builds and pip 2017-01-28 19:58:32 -08:00
RELNOTES.md PyLink 1.1.1 2017-02-24 17:56:43 -08:00
setup.py setup.py: install pylink-mkpasswd as a script 2017-01-28 23:27:24 -08:00
structures.py DataStore: log the name of the current database implementation to DEBUG 2016-11-09 22:56:57 -08:00
utils.py ServiceBot: verify that the service name is a valid nick 2017-01-21 11:59:43 -08:00
VERSION PyLink 1.1.1 2017-02-24 17:56:43 -08:00
world.py core: rename IrcUser.identified attribute to IrcUser.account 2016-07-29 20:16:05 -07:00

PyLink IRC Services

PyPI version PyPI supported Python versions PyPi license Live chat

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.

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)

Support

First, MAKE SURE youve 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 youd 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.

Installation

Installing from source

First, make sure the following dependencies are met:

  • Python 3.4+
  • Setuptools (pip3 install setuptools)
  • PyYAML (pip3 install pyyaml)
  • ircmatch (pip3 install ircmatch)
  • For password encryption: Passlib (pip3 install passlib)
  • For the servprotect plugin: expiringdict (install this from source; installation is broken in pip due to mailgun/expiringdict#13)
  1. Clone the repository: git clone https://github.com/GLolol/PyLink && cd PyLink

  2. Pick your branch.

  • By default youll be on the master (stable) branch, which is bugfix only for the most part (except when a new stable release is introduced).
  • However, new features or more intensive bug fixes may not always be included. Instead, the devel (pre-release) branch is where active development goes, and it can be accessed by running git checkout devel in your Git tree.
  1. Install PyLink using python3 setup.py install (global install) or python3 setup.py install --user (local install)
  • Note: --user is a literal string; do not replace it with your username.
  • Whenever you switch branches or update PyLinks sources via git pull, you will need to re-run this command for changes to apply!

Installing via PyPI (stable branch only)

  1. Make sure youre running the right pip command: on most distros, pip for Python 3 uses the command pip3.

  2. Run pip3 install pylinkirc to download and install PyLink. pip will automatically resolve dependencies.

  3. Download or copy https://github.com/GLolol/PyLink/blob/master/example-conf.yml for an example configuration.

Installing via Debian APT repository (stable branch only)

The Utopia Repository hosts .deb packages for PyLink. For Debian Jessie (stable) and Stretch/sid (testing), the pylink package and its dependencies are available in the main section. See https://packages.overdrivenetworks.com/#instructions for setup instructions.

Upon installing pylink, example configurations and docs will be in /usr/share/doc/pylink/examples and /usr/share/doc/pylink/docs respectively. You can also install a local copy of the PyLink API reference, which is provided by the pylink-doc package.

Installing via Ubuntu PPA (stable branch only)

Ubuntu packages for PyLink are available from the PyLink PPA for Ubuntu 14.04 LTS (trusty) and above. Like with the Debian installation, example configurations and docs will be in /usr/share/doc/pylink/examples and /usr/share/doc/pylink/docs respectively.

Configuration

  1. Rename example-conf.yml to pylink.yml (or a similarly named .yml file) and configure your instance there. Note that the configuration format isnt finalized yet - this means that your configuration may break in an update!

  2. Run pylink from the command line. PyLink will load its configuration from pylink.yml by default, but you can override this by running pylink with a config argument (e.g. pylink mynet.yml).

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+) - module ts6
  • InspIRCd 2.0.x - module inspircd
    • For vHost setting to work, m_chghost.so must be loaded.
    • Supported channel, user, and prefix modes are negotiated on connect, but hotloading modules that change these is not supported. After changing module configuration, it is recommended to SQUIT PyLink to force a protocol renegotiation.
  • 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.
  • UnrealIRCd 4.x - module unreal
    • Linking to UnrealIRCd 3.2 servers is only possible when using an UnrealIRCd 4.x server as a hub, with topology such as pylink<->unreal4<->unreal3.2. We nevertheless encourage you to upgrade so all your IRCds are running the same version.

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 3.0.x (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.
  • ircd-ratbox (3.x) - module ratbox
    • Host changing is not supported on ircd-ratbox.
    • On ircd-ratbox, all known IPs of users will be shown in /whois, even if the client is a cloaked relay client: if youre paranoid about this, turn off Relay IP forwarding by setting the relay_no_ips option in the ratbox networks server: block.
  • juno-ircd (11.x / janet) - module ts6 (see configuration example)

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

Clientbot

Since v1.0, PyLink supports connecting to IRCds as a relay bot and forwarding users back, similar to Janus Clientbot. This can be useful if the IRCd a network used isnt supported, or if you want to relay certain channels without fully linking with a network.

For Relay to work properly with Clientbot, be sure to load the relay_clientbot plugin in conjunction with relay.