pinhook
The pluggable python framework for IRC bots and Twitch bots
Documentation: https://archangelic.github.io/pinhook/
Installation
pip install pinhook
Quick start
Make a plugins folder with this in plugins/hello.py:
import pinhook.plugin
@pinhook.plugin.command('!hello', help_text='says hello back')
def hello(msg):
return pinhook.plugin.message('hi {}!'.format(msg.nick))
Then start a bot, from a python file:
from pinhook.bot import Bot
bot = Bot(
channels=['#foo'],
nickname='ph-bot',
server='irc.libera.chat',
port=6697,
ssl_required=True,
)
bot.start()
or from a config file, with pinhook config.yaml:
nickname: "ph-bot"
server: "irc.libera.chat"
port: 6697
ssl_required: true
channels:
- "#foo"
Say !hello in #foo and the bot answers.
Learn more
- Getting started
- Options
- Built-in commands
- Writing plugins
- Bans and ops
- Twitch bots
- Troubleshooting
- Upgrading to 1.11
Examples
There are some basic examples in the examples directory in this repository.
Here is a list of live bots using pinhook:
- pinhook-tilde - fun bot for tilde.town
- adminbot - admin helper bot for tilde.town, featuring some of the ways you can change the Bot class to suit your needs
1 maintainer
Metadata
1 maintainer
Release files for pinhook 1.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pinhook-1.11.0.tar.gz | 23.9 kB | With provenance | Details for pinhook-1.11.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pinhook-1.11.0-py3-none-any.whl | Python 3 | none | any | Details for pinhook-1.11.0-py3-none-any.whl |
Total release size: 38.6 kB
Release files / pinhook-1.11.0.tar.gz
| Download URL | pinhook-1.11.0.tar.gz |
|---|---|
| Size | 23.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
899e559e4b16cb14f1316f7954131d61c6e672cbb4cc714239d9f952ae6f632f
|
|
BLAKE2b-256 checksum How to use checksums |
198ac82dee0e77d20de6c5c35afdd5ed83f7b958a72340ba5c10524df5df10f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.
Transparency logRelease files / pinhook-1.11.0-py3-none-any.whl
| Download URL | pinhook-1.11.0-py3-none-any.whl |
|---|---|
| Size | 14.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
468bb9378a010e3f201ebbfda9d6055272d5c58777aedf905dd215adcd023ef2
|
|
BLAKE2b-256 checksum How to use checksums |
8386cb6fdc2ca6d0a4d4c661736c4000d232082e9d5f7ae9b1ea7b5e2468779b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.
Transparency logSecurity for pinhook 1.11.0
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for pinhook-1.11.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.
Transparency logA 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.
