README.md

SCP-079-REGEX

This project is used to manage regular expression rules adopted by other bots.

How to use

• See this article to build a bot by yourself
• README of the SCP-079 Project
• Discuss group

Features

• Easy to use
• Can merge similar or mutually contained rules
• Search patterns
• Test patterns

To Do List

• Complete phrase management for a single group
• Check the pattern before add
• Choose the right way to store data
• Interfacing with the whole project database
• Search for patterns in more ways
• Test patterns in a group
• Simplified Chinese to Traditional Chinese
• Copy the same pattern to other groups
• Support the HIDE channel
• Add more types
• Follow the hard core interaction principle

Requirements

• Python 3.6 or higher.
• Debian 10: sudo apt update && sudo apt install opencc -y
• pip: pip install -r requirements.txt or pip install -U APScheduler OpenCC pyAesCrypt pyrogram[fast] xeger

Files

• plugins
  • functions
    • channel.py : Functions about channel
    • etc.py : Miscellaneous
    • file.py : Save files
    • filters.py : Some filters
    • receive.py : Receive data from exchange channel
    • telegram.py : Some telegram functions
    • tests.py : Test functions
    • timers.py : Timer functions
    • words.py : Manage words
  • handlers
    • callback.py : Handle callbacks
    • command.py : Handle commands
    • message.py: Handle messages
  • glovar.py : Global variables
• .gitignore : Ignore
• config.ini.example -> config.ini : Configuration
• LICENSE : GPLv3
• main.py : Start here
• README.md : This file
• requirements.txt : Managed by pip

Contribute

Welcome to make this project even better. You can submit merge requests, or report issues.

License

Licensed under the terms of the GNU General Public License v3.