Skip to main content

Chumbot

The Conveying Harmonies Unto Mumble Bot, or Chumbot, is a Mumble soundboard and notification bot written in Python 3. Chumbot relies on the PYMUMBLE API, which requires the opuslib and protobuf Python libraries as well as libopus being available on the host machine.

Chumbot is currently not supported on Windows.

Installation

For users

The Chumbot client can be installed via pip:

pip install chumbot

For developers

Chumbot can be installed for development by first installing Poetry and running the following command within the project directory:

poetry install

Usage

Chumbot is run from the command line. Audio clips should be stored in mp3 format.

usage: chumbot [-h] [-u USERNAME] [-H HOST] [-P PORT] [-p PASSWORD] [-d]

Chumbot command-line interface

options:
  -h, --help            show this help message and exit
  -u USERNAME, --username USERNAME
                        specify Chumbot's username
  -H HOST, --host HOST  specify the Mumble host address
  -P PORT, --port PORT  specify the Mumble host port
  -p PASSWORD, --password PASSWORD
                        specify the Mumble host password
  -d, --debug           enable debug message printing

Configuration

Chumbot configuration is stored in ~/.config/chumbot.ini. Chumbot must be configured to know where audio files are stored.

Chumbot can be configured to play a specific clip when a link or image is posted or when a user joins or leaves a channel. It can even be configured to play a personalized 'join' or 'disconnect' sound for each user.

An example chumbot.ini:

[mumble]
Username = chumbot
Host = example.murmur.nfoservers.com
Port = 2112
Password = 1234

[clips]
ClipDir = ~/chumbot-clips
LinkPostedClipName = link_clip
UserJoinedClipName = default_join_clip
UserLeftClipName = default_leave_clip

[join]
user1 = join_clip1
user2 = join_clip2
user3 = join_clip3

[disconnect]
user1 = disconnect_clip1
user2 = disconnect_clip2
user3 = disconnect_clip3

Contributing

Contributions are taken and any pull requests will be reviewed by me (eventually).

Please attempt to adhere to the coding practices in .pylintrc. Ensure no pylint warnings are generated before creating a PR.

Metadata

Release files for chumbot 0.7.3

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

Source distribution (sdist)

Source distribution for chumbot 0.7.3
File Size Uploaded Provenance Actions
chumbot-0.7.3.tar.gz 11.9 kB Without provenance Details for chumbot-0.7.3.tar.gz

Built distribution (wheel)

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

Total release size: 25.5 kB

Release files / chumbot-0.7.3.tar.gz

Download URL chumbot-0.7.3.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
80c224b0bba471077b456673bf87ff3ec9fb786159b7b8e56d7cb6ea5a2a9ed3
BLAKE2b-256 checksum
How to use checksums
9b57f8c116ec2edbc6f25dabf6cf48ef1a4b65295fe2d5a41a8bebd23b8d67c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.8.13 Linux/5.10.194-1-MANJARO

Release files / chumbot-0.7.3-py3-none-any.whl

Download URL chumbot-0.7.3-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b6537620f99c03a775006f09ffd2b6d08b8c28be905d58b78b231b24cd09c4f
BLAKE2b-256 checksum
How to use checksums
d36b18db6a12a2fdbb527e701a98f5007e7f4ae82ad1700480b275ffd3eb0184
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.8.13 Linux/5.10.194-1-MANJARO

Security for chumbot 0.7.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.7.3 This release

2 release files No provenance

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