Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sopel-irc/sopel-reddit
A reddit plugin for Sopel IRC bots.
https://github.com/sopel-irc/sopel-reddit
hacktoberfest reddit reddit-api sopel sopel-plugin
Last synced: about 1 month ago
JSON representation
A reddit plugin for Sopel IRC bots.
- Host: GitHub
- URL: https://github.com/sopel-irc/sopel-reddit
- Owner: sopel-irc
- License: other
- Created: 2023-04-19T03:04:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-25T14:10:11.000Z (9 months ago)
- Last Synced: 2024-05-01T11:36:56.767Z (8 months ago)
- Topics: hacktoberfest, reddit, reddit-api, sopel, sopel-plugin
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# sopel-reddit
A reddit plugin for Sopel IRC bots.
## Installation
**Stable version:**
```sh
pip install sopel-reddit
```
### From source
```sh
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
```ini
[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](https://old.reddit.com/r/reddit/comments/12qwagm/an_update_regarding_reddits_api/).
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](https://github.com/sopel-irc/sopel/commits/master/sopel/modules/reddit.py).