https://github.com/briancline/ircu-python

Python library providing an Undernet-ircu state machine, speaking with its uplink via the P10 protocol. Provides all the plumbing necessary to write ircu-based network services.
https://github.com/briancline/ircu-python

Last synced: 16 days ago
JSON representation

Python library providing an Undernet-ircu state machine, speaking with its uplink via the P10 protocol. Provides all the plumbing necessary to write ircu-based network services.

• Host: GitHub
• URL: https://github.com/briancline/ircu-python
• Owner: briancline
• License: mit
• Created: 2013-11-20T03:00:13.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2016-07-27T06:45:09.000Z (over 8 years ago)
• Last Synced: 2023-03-10T20:05:07.213Z (almost 2 years ago)
• Language: Python
• Size: 40 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
ircu-python

===========

.. image:: https://travis-ci.org/briancline/ircu-python.svg?branch=master

    :target: https://travis-ci.org/briancline/ircu-python

Python library providing an Undernet-ircu network state machine and speaking

with its uplink via the P10 protocol. Provides all the plumbing necessary to

write ircu-based network services.

Requirements

------------

* Python 2.7, 3.4, or 3.5

Example Service

---------------

To create a basic service that successfully connects and watches events,

begin with the following configuration file::

    [uplink]

    host = localhost

    port = 4400

    password = s3cr3t

    [server]

    numeric = 1234

    name = service.example.com

    info = Test Service

    modes = s

    max_clients = 512

    [bot]

    nick = SpyBot

    ident = stealth

    host = example.com

    ip = 0.0.0.0

    info = Here to spy on you

    modes = owk

    [logging]

    level = DEBUG

Then, use the following code to instantiate, connect, and begin running an

event loop::

    #!/usr/bin/env python

    from ircu import service

    from ircu import util

    cfg = util.load_config('etc/example.ini')

    svc = service.Service(cfg)

    svc.run()

License

-------

This software is licensed under the MIT License. See the LICENSE file for

all the thrilling details.