Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.2 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.2 KB
Raw

sopel-reddit

A reddit plugin for Sopel IRC bots.

Installation

Stable version:

pip install sopel-reddit

From source

pip install -e path/to/sopel-reddit

# optional: for development
pip install -r dev-requirements.txt

Note: Running the test suite with pytest -v tests/ requires both sopel-reddit and sopel itself to be installed in the same venv.

Configuration

[reddit]
slash_info = True
# Allow expansion of inline references like `u/RandomRedditor` or `r/eyebleach`
# (links are always expanded)

app_id = abcdef0123456789
# Optional custom app ID for the reddit API

The app_id setting is provided mostly for future-proofing after API policy changes announced by Reddit Inc. in April 2023. It exists so possible future API limitations can be worked around by users without requiring a package update. As of the time this package version was published, the app_id setting does not need to have a value.

Special thanks

All contributors to the original reddit plugin for Sopel.