{"id":19416834,"url":"https://github.com/ethanc/snoopy","last_synced_at":"2025-04-14T13:22:13.690Z","repository":{"id":38961964,"uuid":"239671828","full_name":"EthanC/Snoopy","owner":"EthanC","description":"Monitor users on Reddit and notify about post activity. ","archived":false,"fork":false,"pushed_at":"2025-03-11T07:50:36.000Z","size":275,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T02:38:01.739Z","etag":null,"topics":["comment","discord","monitor","notification","notifier","pin","pinned","post","python","reddit","redditor","reply","sticky","thread","user","watcher","webhook"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/ethanchrisp/snoopy","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EthanC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yaml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://cash.app/$EthanChrisp","https://venmo.com/u/Mxtive"]}},"created_at":"2020-02-11T03:59:19.000Z","updated_at":"2025-03-11T07:50:39.000Z","dependencies_parsed_at":"2023-02-18T19:46:06.538Z","dependency_job_id":"7b9be431-33ff-401e-96e0-fc44613cfa1c","html_url":"https://github.com/EthanC/Snoopy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSnoopy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSnoopy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSnoopy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSnoopy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EthanC","download_url":"https://codeload.github.com/EthanC/Snoopy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248886467,"owners_count":21177672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comment","discord","monitor","notification","notifier","pin","pinned","post","python","reddit","redditor","reply","sticky","thread","user","watcher","webhook"],"created_at":"2024-11-10T13:05:46.198Z","updated_at":"2025-04-14T13:22:13.664Z","avatar_url":"https://github.com/EthanC.png","language":"Python","readme":"# Snoopy\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/EthanC/Snoopy/ci.yaml?branch=main) ![Docker Pulls](https://img.shields.io/docker/pulls/ethanchrisp/snoopy?label=Docker%20Pulls) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/ethanchrisp/snoopy/latest?label=Docker%20Image%20Size)\n\nSnoopy monitors users on Reddit and notifies about post activity via Discord.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/x3eLTpA.png\" draggable=\"false\"\u003e\n\u003c/p\u003e\n\n## Setup\n\n[Reddit API](https://github.com/reddit-archive/reddit/wiki/OAuth2#getting-started) credentials are required for functionality, and a [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) is recommended for notifications.\n\nRegardless of your chosen setup method, Snoopy is intended for use with a task scheduler, such as [cron](https://crontab.guru/).\n\n**Environment Variables:**\n\n-   `LOG_LEVEL`: [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to write to the console.\n-   `LOG_DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive log events.\n-   `LOG_DISCORD_WEBHOOK_LEVEL`: Minimum [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to forward to Discord.\n-   `REDDIT_USERNAME` (Required): Reddit account username.\n-   `REDDIT_PASSWORD` (Required): Reddit account password.\n-   `REDDIT_CLIENT_ID` (Required): [Reddit API](https://github.com/reddit-archive/reddit/wiki/OAuth2#getting-started) application client ID.\n-   `REDDIT_CLIENT_SECRET` (Required): [Reddit API](https://github.com/reddit-archive/reddit/wiki/OAuth2#getting-started) application client secret.\n-   `DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive Reddit activity notifications.\n\n**Configurable Variables** (`config.json`)**:**\n\n-   `users` (Required): Array of dicts containing options for watching Reddit users.\n    -   `username` (Required): Username of the desired Reddit user\n    -   `label`: Label to be displayed alongside the username and post flair\n    -   `communities`: Array of strings containing Reddit subreddit names\n\n### Docker (Recommended)\n\nRename `config_example.json` to `config.json`, then provide the configurable variables.\n\nModify the following `compose.yaml` example file, then run `docker compose up`.\n\n```yml\nservices:\n  snoopy:\n    container_name: snoopy\n    image: ethanchrisp/snoopy:latest\n    environment:\n      LOG_LEVEL: INFO\n      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY\n      LOG_DISCORD_WEBHOOK_LEVEL: WARNING\n      REDDIT_USERNAME: XXXXXXXX\n      REDDIT_PASSWORD: XXXXXXXX\n      REDDIT_CLIENT_ID: XXXXXXXX\n      REDDIT_CLIENT_SECRET: XXXXXXXX\n      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX\n    volumes:\n      - /path/to/config.json:/snoopy/config.json:ro\n```\n\n### Standalone\n\nSnoopy is built for [Python 3.12](https://www.python.org/) or greater.\n\n1. Install required dependencies using [uv](https://github.com/astral-sh/uv): `uv sync`\n2. Rename `.env_example` to `.env`, then provide the environment variables.\n3. Rename `config_example.json` to `config.json`, then provide the configurable variables.\n4. Start Snoopy: `python snoo.py`\n","funding_links":["https://cash.app/$EthanChrisp","https://venmo.com/u/Mxtive"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethanc%2Fsnoopy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethanc%2Fsnoopy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethanc%2Fsnoopy/lists"}