Sanitizer Bot (Python)

Introduction

Sanitizer is a simple bot that uses regex to identify links for social platforms and replaces them with discord embed friendly links that allows you to view the content of the link without ever having to leave the discord app. You might think this is a bot for lazy people, but I assure you, if you give it a try, you'll never want to go back.

The bot is developed in Python using the interactions.py library. Click here for their GitHub repo. This GitHub repo is utilized for version control and the assistance of GitHub Copilot has been used for creating examples of implementation from documentations.

TODO

• Add Reddit Support
• Add a config panel

Features

• User Privacy first: No logs are made on any messages users send.
• Supports Multiple platforms: Currently works with Twitter, TikTok, Instagram. More to come!
• Automatic conversion: Automatically fixes any supported links posted.
• User Installable App: The /sanitize app command can be used anywhere.
• Handles Direct Messages: Will attempt to fix links sent in private.
• Implemented QuickVids API: Implemented QuickVids API to convert TikTok links into embeddable content in discord.

Getting Started

If you wish to host your own instance of the Sanitizer bot, follow along.

Prerequisites

• Python 3.12 or higher
• A Discord account

Installation

1. Clone the repository:

   git clone https://github.com/suhaybu/sanitizer-bot.git

2. Setup virtual Python environment:

   python3 -m venv .venv

3. Activate virtual Python environment: on Linux or MacOS

   source .venv/bin/activate

   on Windows

   .venv\Scripts\activate

4. Install the required packages:

   pip install -r requirements.txt

5. Set up your Bot Token: Add your Discord bot token to the .env file present in the root directory.

6. Set up your QuickVids Token (for TikTok): Get your QuickVids api token from here.

Running the Bot

To run the bot, use the following command:

python3 main.py

Usage

Once the bot is running, you can use the following commands:

• /credits: To roll the credits

•   `/sanitize`: To fix the embed of your link
  

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the CCO License. See LICENSE for more information.

Contact

Suhayb - @suhayb_u

Project Link: https://github.com/suhaybu/sanitizer-bot

Acknowledgments

• interactions.py
• Twitter: Thanks to FixTweet's awesome FxTwitter project
• TikTok: Thanks to QuickVids super fast API
• Instagram: Thanks to InstaFix's reliable service