Skip to main content

pyrcb2

pyrcb2 is an asyncio-based library for writing IRC bots. It is designed to be easy to use, customizable, and high-level.

pyrcb2 includes features such as account tracking, user prefix tracking (voice, op, etc.), messaging delaying to prevent throttling, and long message splitting.

pyrcb2 also makes use of asyncio and coroutines in Python. This allows you to write asynchronous code in a linear fashion—you can handle responses to commands right after you send them.

# Wait until the bot has joined #channel.
await bot.join("#channel")
print("There are", len(bot.users["#channel"]), "users in #channel.")

# Get user1's account.
result = await bot.get_account("user1")
if result.success:
    account = result.value or "(no account)"
    print("user1 is logged in as", account)

Installation

Install with pip:

$ pip3 install pyrcb2

Or download the source code and install with setup.py:

$ ./setup.py install

Alternatively, you can download the source code and install with pip:

$ pip3 install .

You will need to run the commands above as root if you’re installing globally. You can use the --user option to install to your home directory instead.

Documentation

Documentation for pyrcb2 is available at https://pythonhosted.org/pyrcb2/. If you’re new to pyrcb2, start with this guide and take a look at the examples.

Tests

To run pyrcb2’s tests, run python3 -m tests. If you have coverage installed, you can run coverage run -m tests.__main__ to get information on test coverage.

License

pyrcb2 is licensed under the GNU Lesser General Public License, version 3 or later. Some parts are released under other licenses; see the full license notice and individual files for details.

Release files for pyrcb2 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 pyrcb2 0.4.0
File Size Uploaded
pyrcb2-0.4.0.tar.gz 173.4 kB Details

Built distribution (wheel)

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

Total release size: 276.1 kB

Release files / pyrcb2-0.4.0.tar.gz

Download URL pyrcb2-0.4.0.tar.gz
Size 173.4 kB
Tags Source
SHA-256 checksum
How to use checksums
ce75e32f95ed8a023495b9cd6e22232377f28b6025deb6fd15e58a762c323b8e
BLAKE2b-256 checksum
How to use checksums
6c7e5aa32f7b3c66d10dacebc216641b22b6631b23847fa5e828bb654835c1b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL pyrcb2-0.4.0-py3-none-any.whl
Size 102.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dfbe6462e9dce281c0b80e82098e30dfa302da0dfe3f65fddb44f12e17ea6295
BLAKE2b-256 checksum
How to use checksums
74e2069c0fe1921bcf0d8f5d2746b5bae349c624229f8997410bbc459bb6f8eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

This release

0.4.0 This release

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

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