Skip to main content

A channel logging plugin for Sopel (replaced)

Project description

sopel-chanlogs

A channel logging plugin for Sopel IRC bots

This package no longer receives updates. Please upgrade to Sopel 8.0+ and sopel-chanlogs when you are able to do so.

Requirements

sopel-chanlogs requires only Sopel 7.x itself.

Usage

Install the package from PyPI:

pip install sopel-modules.chanlogs

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

Configuration

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.

Project details


Download files

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

Source Distribution

sopel_modules_chanlogs-0.2.3.post0.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page