Skip to main content

An efficient and simple anti-spam system made for your discord bots.

Project description

Spam Filter

A simple and efficient spam filter built to be used in discord bots made with any fork of discord.py!

Installation

pip install git+https://github.com/DorianAarno/SpamFilter.git

Usage

Quickstart Guide

from SpamFilter import AntiSpam

@bot.event
async def on_message(msg):
  spam_check = AntiSpam().check(bot, msg.channel, msg.author)

Detailed Guide

from SpamFilter import AntiSpam

dictionary_check = True # Default is False, DO NOT USE THIS IF YOUR SERVER IS MULTI-LINGUAL, Checks if any word in the message is present in english dictionary.
timer_check = True # Default is True, Checks if a member has sent more than 5 messages within 15 seconds, if yes, 6th message is marked as spam.
content_check = True # Default is True, Checks the message's content and if a letter whose occurance in the content is highest covers more than 85% of the content, it marks the message as spam.
history_check = True # Default is True, Checks if the message's content is duplicate of the previous message.

@bot.event
async def on_message(msg):
  spam_check = AntiSpam(
    dictionary = dictionary_check,
    timer = timer_check,
    content = content_check,
    history = history_check
  ).check(bot, msg.channel, msg.author)

Example

You may view implementation of this library in PointsBot.

Notes

  • This library has only been tested with discord-disnake.
  • Your bot needs to have access to message content.

Contributing

  • Fork the repository.
  • Add your desired change or filter.
  • Open pull request.
  • Issues are welcome.
  • Consider giving this repository a ⭐, It is highly appreciated!

License

This repository has been made available via MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

discordpy-antispam-1.0.3.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

discordpy_antispam-1.0.3-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file discordpy-antispam-1.0.3.tar.gz.

File metadata

  • Download URL: discordpy-antispam-1.0.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for discordpy-antispam-1.0.3.tar.gz
Algorithm Hash digest
SHA256 f828098ff678681f406f6ade4fb4335daebf5769966c91f8454615d60381dc17
MD5 7cc4d02a2aad8bebfd5440460ec5cb72
BLAKE2b-256 726614e9c4490c7bc5bccb237e71119748a898747f3a9fa15a663a4e8f17e1da

See more details on using hashes here.

File details

Details for the file discordpy_antispam-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for discordpy_antispam-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 99eb8ccf68f8dd2df39bb66287c89c5c5aba095fd9fc89ed7aa4fbd482cca595
MD5 a4ee887f90b2909ca13ebb436d17ebff
BLAKE2b-256 5688c26248691e99fb0b3ad271ab3b55305555b735d33f5bb230bb55f675de08

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page