Welcome to Discord Anti-Spam’s documentation!

In order to tell AntiSpamHandler what library you are using you should pass the library kwarg. For the supported libraries, please see the Library enum in the Enum reference page.

The package features some built in punishments, these are:

• Per member spam:

  • Warn -> Kick -> Ban. This is default in versions lower then 1.3.0

  • Discord timeouts. This is default in versions 1.3.0 or higher.

Primary Interface:

• Main Interface
• Cache Choices
  • Redis Cache
  • MongoDB Cache
• Possible Modes
  • Default
  • Per Member Per Channel
  • Max Message Amount
• Example usages
  • Super duper basic bot
  • Basic Hikari bot
  • How to use templating in a string
  • Cog Based Usage
  • How to use templating in embeds
  • Custom Punishments
• Package Logging
  • Basic Usage
• Message Templating
  • Templating Options
  • Templating Usage
  • Embed Templating
• Migrating to 1.0
  • Changes
  • Features
  • Fixes
• Changelog
  • 1.3.0 -> 1.4.0
  • 1.2.11 -> 1.3.0
  • 1.2.8 -> 1.2.9
  • 1.2.(3-7) -> 1.2.8
  • 1.2.2 -> 1.2.3
  • 1.2.1 -> 1.2.2
  • 1.2.0 -> 1.2.1
  • 1.1.3 -> 1.2.0
  • 1.1.2 -> 1.1.3

Main Interaction Classes

• Enum Reference
• Option’s Reference
• CorePayload Reference

Plugin Framework

• Package Plugin System
  • Plugin Blacklisting
  • Call Stack
• Plugin Class Schema
  • Pre-invoke Schema
  • After-invoke Schema
  • Cancelling Invocation
• Plugin-Cache Interaction
• AntiSpamTracker Plugin
• AntiMassMention Plugin
• Statistics Plugin
• AdminLogs Plugin
• MaxMessageLimiter Plugin

Object Reference:

• Object Overview
  • Plugin developers
• Abc Reference
• ASH Exceptions
• Guild Reference
• Member Reference
• Message Reference
• RedisCache Reference
• MemoryCache Reference
• MongoCache Reference
• PropagateData Object Reference
• Lib Base Object
• SubstituteArgs Object
• Plugin BasePlugin Object

Install Notes

Initial install will get you a working version of this lib, however it is recommended you also install python-Levenshtein to speed this up. This does require c++ build tools, hence why it is not included by default.

Indices and tables

• Index

• Module Index

• Search Page