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.

Metadata

Release files for pyrcb2 0.3.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.3.0
File Size Uploaded
pyrcb2-0.3.0.tar.gz 99.7 kB Details

Built distribution (wheel)

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

Total release size: 150.2 kB

Release files / pyrcb2-0.3.0.tar.gz

Download URL pyrcb2-0.3.0.tar.gz
Size 99.7 kB
Tags Source
SHA-256 checksum
How to use checksums
9301901b91bbe31da160dcb546386bfd2b0ee34c3daefe89456de7c6abac2949
BLAKE2b-256 checksum
How to use checksums
a3de4f7fb24c5d354c8ead7b01103c7a7dbf3fc8d641f69be7f06418859302b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL pyrcb2-0.3.0-py3-none-any.whl
Size 50.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dec2b8638d58952d2c1515700956d3f94eb510b65c23ea6dec0f69cff3b7d7f0
BLAKE2b-256 checksum
How to use checksums
d283d7a9612ee62ca50432b529b56a3a7c627f3461757e8291ea17a60123f153
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

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

This release

0.3.0 This release

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