Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ethanc/moniker

Monitor usernames across several platforms and report availability.
https://github.com/ethanc/moniker

availability available discord docker docker-compose github mastodon monitor notifications notifier notify portainer python script snapchat twitter username watcher webhook youtube

Last synced: 3 days ago
JSON representation

Monitor usernames across several platforms and report availability.

Host: GitHub
URL: https://github.com/ethanc/moniker
Owner: EthanC
License: mit
Created: 2022-11-13T06:17:28.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-08-25T04:20:29.000Z (3 months ago)
Last Synced: 2024-08-25T05:26:58.205Z (3 months ago)
Topics: availability, available, discord, docker, docker-compose, github, mastodon, monitor, notifications, notifier, notify, portainer, python, script, snapchat, twitter, username, watcher, webhook, youtube
Language: Python
Homepage: https://hub.docker.com/r/ethanchrisp/moniker
Size: 469 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Moniker

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/EthanC/Moniker/ci.yaml?branch=main) ![Docker Pulls](https://img.shields.io/docker/pulls/ethanchrisp/moniker?label=Docker%20Pulls) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/ethanchrisp/moniker/latest?label=Docker%20Image%20Size)

Moniker monitors usernames across various services and reports availability via Discord.

-   [Cash App](https://cash.app/)

-   [GitHub](https://github.com/)

-   [Mastodon](https://mastodon.social/)

-   [Snapchat](https://www.snapchat.com/)

-   [Venmo](https://venmo.com/)

-   [X](https://x.com/)

-   [YouTube](https://youtube.com/)



    



## Setup

Although not required, a [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) is recommended for notifications.

Regardless of your chosen setup method, Moniker is intended for use with a task scheduler, such as [cron](https://crontab.guru/).

**Environment Variables:**

-   `LOG_LEVEL`: [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to write to the console.

-   `LOG_DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive log events.

-   `LOG_DISCORD_WEBHOOK_LEVEL`: Minimum [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to forward to Discord.

-   `CASHAPP_USERNAMES`: Comma-separated list of [Cash App](https://cash.app/) $Cashtags to monitor.

-   `GITHUB_USERNAMES`: Comma-separated list of [GitHub](https://github.com/) usernames to monitor.

-   `MASTODON_USERNAMES`: Comma-separated list of [Mastodon](https://mastodon.social/) usernames to monitor.

-   `SNAPCHAT_USERNAMES`: Comma-separated list of [Snapchat](https://www.snapchat.com/) usernames to monitor.

-   `VENMO_USERNAMES`: Comma-separated list of [Venmo](https://www.venmo.com/) usernames to monitor.

-   `X_USERNAMES`: Comma-separated list of [X](https://x.com/) usernames to monitor.

-   `GITHUB_USERNAMES`: Comma-separated list of [Venmo](https://venmo.com/) usernames to monitor.

-   `YOUTUBE_USERNAMES`: Comma-separated list of [YouTube](https://youtube.com/) usernames to monitor.

-   `DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive available username notifications.

### Docker (Recommended)

Modify the following `compose.yaml` example file, then run `docker compose up`.

```yml

services:

  moniker:

    container_name: moniker

    image: ethanchrisp/moniker:latest

    environment:

      LOG_LEVEL: INFO

      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY

      LOG_DISCORD_WEBHOOK_LEVEL: WARNING

      CASHAPP_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      GITHUB_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      MASTODON_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      SNAPCHAT_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      VENMO_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      X_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      YOUTUBE_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ

      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX

```

### Standalone

Moniker is built for [Python 3.12](https://www.python.org/) or greater.

1. Install required dependencies using [uv](https://github.com/astral-sh/uv): `uv sync`

2. Rename `.env.example` to `.env`, then provide the environment variables.

3. Start Moniker: `python moniker.py`