sopel-chanlogs

A channel logging plugin for Sopel IRC bots

Installing

Releases are hosted on PyPI, so after installing Sopel, all you need is pip:

$ pip install sopel-chanlogs

Enable the plugin with sopel-plugins enable chanlogs, if your bot configuration requires it.

Requirements

sopel-chanlogs requires only Sopel itself, version 8.0 or higher.

Usage

Configuration

The easiest way to configure sopel-chanlogs is via Sopel's configuration wizard—simply run sopel-plugins configure chanlogs and complete the prompts. All settings are optional, falling back on sensible defaults.

dir
Path to channel log storage directory. Default: ~/chanlogs
by_day
Split log files by day. Default: True
privmsg
Record private messages. Default: False
microseconds
Include microseconds in log timestamps. Default: False
localtime

Attempt to use preferred timezone (the bot's core.default_timezone) instead of UTC. Default: False

Please note that Sopel's default default_timezone is UTC.

Advanced configuration

Log line templates can be overridden using the relevant setting from this list:

  • message_template
  • action_template
  • join_template
  • part_template
  • quit_template
  • nick_template
  • topic_template

Each template is formatted using the following {placeholder} values:

  • the trigger, with all of its attributes (see Sopel's documentation)
  • the date in ISO format
  • the time in ISO format
  • the full datetime in ISO format

For convenience, the message_template also receives a message placeholder.

Please consult the plugin's code for current default templates.

Changelog

0.3.1

Fixed:

  • Handle CTCP ACTIONs correctly in modern Sopel style (#13)

Meta:

  • Package license metadata now PEP 639 compliant

0.3.0

First release as sopel-chanlogs, replacing sopel_modules.chanlogs.

Changed:

  • Modernize packaging, target Sopel 8.0+, take advantage of new Sopel API features, and support only Python 3.8+

Meta:

  • Fixed package metadata to credit the original author(s) and current maintainer(s) correctly

0.2.3

Fixed:

  • Switch from obsolete clock.tz setting to core.default_timezone (#11)

Meta:

  • Greatly improved documentation of settings (#12)

0.2.2

Changed:

  • Replaced deprecated call to SopelMemory.contains() (#8)

0.2.1

Meta:

  • Added project README file
  • Use README as project's PyPI description

0.2.0

Changed:

  • Target Sopel 7.x (#5)

Added:

  • Support for logging topic changes (#3)
  • Support for echo-message (#4)

Fixed:

  • Install errors (#1)
  • Startup/config glitches (#2)

0.1.0

First release of sopel_modules.chanlogs.

Project links

Data verified by PyPI on Sep 24, 2025
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: David Baumgold, Elsie Powell

Maintainer: dgw

GitHub Statistics

Data verified by PyPI on Sep 24, 2025
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

EFL-2.0
View SPDX License List

Requires

Python <4, >=3.8

Tags

sopel plugin bot irc

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sopel_chanlogs-0.3.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sopel_chanlogs-0.3.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file sopel_chanlogs-0.3.1.tar.gz.

File metadata

  • Download URL: sopel_chanlogs-0.3.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sopel_chanlogs-0.3.1.tar.gz
Algorithm Hash digest
SHA256 9eb74f8d05d4387c781a7ee4934b8a136d6ba1e89ccf40f201902f447f021ff9
MD5 11a46c6e271c0216494c05704ce2b898
BLAKE2b-256 64606af580307c5a99766cf009ce75daca19c6e87344e115fdc45bd1eaac757b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sopel_chanlogs-0.3.1.tar.gz:

Publisher: pypi.yml on sopel-irc/sopel-chanlogs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sopel_chanlogs-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: sopel_chanlogs-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sopel_chanlogs-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 645575451536671e6f0a9655cb9e127ea022323a2b0a4dbb2666f66731ab3f9a
MD5 e816454c0caf169b953b23a9959ffcc9
BLAKE2b-256 0bb80446be123524e6020ecba4e15da27fc826933328b4f4b72d1c52eacfa0e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for sopel_chanlogs-0.3.1-py3-none-any.whl:

Publisher: pypi.yml on sopel-irc/sopel-chanlogs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 files

0.3.0

2 files

Pre-release

0.3.0.dev0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page