Skip to main content

A channel logging plugin for Sopel

Project description

sopel-chanlogs

A channel logging plugin for Sopel IRC bots

Requirements

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

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.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

sopel_modules.chanlogs-0.2.3-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file sopel_modules.chanlogs-0.2.3.tar.gz.

File metadata

  • Download URL: sopel_modules.chanlogs-0.2.3.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/5.1.0 pkginfo/1.8.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for sopel_modules.chanlogs-0.2.3.tar.gz
Algorithm Hash digest
SHA256 7c15bd40cc2e7d01f39abed0cad75f5edad6f3a8b14f9a2b2dcbaf885a4303bb
MD5 a8584ed2b407981161d0ebe81abb964f
BLAKE2b-256 8ed9dbacd7323e2f26efabe13d7dca5302f0c516508e76d07f40b6c4d194434e

See more details on using hashes here.

Provenance

File details

Details for the file sopel_modules.chanlogs-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: sopel_modules.chanlogs-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/5.1.0 pkginfo/1.8.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for sopel_modules.chanlogs-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a52eaf7808aea955a082971a87f8e202068084a91a672176fbafacf362217fdd
MD5 351e7c3022d37d3b9ec7bba5d9acc41e
BLAKE2b-256 d72fd3b73c1c1ce47168913cb56e046348113941ba09ee7671a12c10df73486c

See more details on using hashes here.

Provenance

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