Skip to main content
gIRC

A modern Python IRC library for Python 3.4, based on asyncio. Currently in alpha.


PyPi Latest Version Travis-CI Build Status Coveralls Code Coverage

If you use this, anything can change without notice, everything can be overhauled, and development may even stop entirely without any warning.

If you would like to help build this, awesome! Otherwise, I’d stay away for now and use another library: irc, irc3.

Hosted Documentation

Features

This library is in development, so these features may be in various levels of completion right now.

  • Incoming and outgoing events.

  • Info and state tracking.

  • Server-based IRC mapping for dicts, lists, and strings.

  • IRCv3 capability support.

  • Escaping and unescaping IRC formatting for ease-of-use (bold, colours, etc).

Why?

I’ve been using another IRC library for a long time. It’s been pretty good, but I need more features. Handling both incoming and outgoing messages, automatic information tracking, converting IRC formatting (bold/colours/etc) to and from an escaped, human-readable and writable format.

I’ve looked at some other libraries, but they’re usually either too low-level, too involved, or too ‘magic’ for my liking. That said, this one is planning to be pretty magic, but it’s going to be magic in a way I think makes sense.

So I decided to write my own. As part of mammon-ircd, a nice low-level library called ircreactor was developed. This is also a chance to give that a spin from the client side, rather than the server side.

Running Tests

To run the test cases, go to the tests directory and run: python3 -m unittest, or use the ./runtests shell script (which also produces coverage graphs).

Acknowledgements

We bundle the ircreactor library developed as a part of mammon-ircd. This license for this library can be found in the LICENSE.ircreactor file.

Release files for girc 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for girc 0.4.0
File Size Uploaded
girc-0.4.0.tar.gz 32.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for girc 0.4.0
File Interpreter ABI Platform
girc-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 72.3 kB

Release files / girc-0.4.0.tar.gz

Download URL girc-0.4.0.tar.gz
Size 32.5 kB
Tags Source
SHA-256 checksum
How to use checksums
54a2290175beea077ed4b683483ca88348a8b7f571b6c4450f55a08324317d3d
BLAKE2b-256 checksum
How to use checksums
bdadd881a538a1b634b278fe242c04484c577001fcf0e9e50157bbdb2b6db087
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

Release files / girc-0.4.0-py3-none-any.whl

Download URL girc-0.4.0-py3-none-any.whl
Size 39.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ce01f263810ae828872a86e45cb7bfaceb9eed993385b959848a63cfcffa6400
BLAKE2b-256 checksum
How to use checksums
deccdb48c6b27df4a8547440e62a9d7ca98bb3758c6500005f04733d0421ecb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.1

1 release file

0.3.0

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

0.0.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page