Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.
/ tor_archivist Public archive

The officially licensed archivist for /r/TranscribersOfReddit

License

Notifications You must be signed in to change notification settings

GrafeasGroup/tor_archivist

Repository files navigation

BugSnag

Archiver Bot - Transcribers Of Reddit

The officially licensed archivist for /r/TranscribersOfReddit!

This is the source code for the bot that handles archiving completed or stale posts from the front page of /r/TranscribersOfReddit, a community dedicated to transcribing images, audio, and video. It acts under the username /u/ToR_archivist.

Resources

  • Redis (tracking completed posts and queue system)
  • Reddit API keys

NOTE:

This code is not complete. The praw.ini file is required to run the bots and contains information such as the useragents and certain secrets. It is built for Python 3.6.

Installation

Make sure you have an up-to-date copy of poetry installed and at least Python 3.9.

$ git clone https://github.com/GrafeasGroup/tor_archivist.git tor_archivist
$ cd tor_archivist/
$ poetry install

High-level functionality

Monitoring daemon (via /r/TranscribersOfReddit/new feed):

  • For each completed or unclaimed post:
    • Retrieve what subreddit contained the original linked post
    • If the post is older than the configured amount of time for target subreddit:

Build

To build the package from source, activate the poetry shell and use the Makefile to create the file. You'll find the built file under build/tor_archivist.pyz.

$ poetry shell
$ make build

Usage

$ tor-archivist
# => [daemon mode + logging]

Contributing

See CONTRIBUTING.md for more.