Welcome to DPY Anti-Spam’s documentation!

DPY Anti-Spam supports discord.py and all forks out of the box assuming they use the discord namespace.

If you want to use this with hikari, please enable it by passing is_using_hikari=True to the AntiSpamHandler constructor.

The package features some built in punishments, these are:

• Per member spam is treated as warns, then kicks followed by bans.
• Per channel spam starts off as a kick straight away followed by bans

Primary Interface:

• Main Interface
• Cache Choices
• 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

Main Interaction Classes

• Enum Reference
• Option’s Reference
• CorePayload Reference

Plugin Framework

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

Object Reference:

• Object Overview
  • Plugin developers
• Abc Reference
• ASH Exceptions
• Guild Reference
• Member Reference
• Message Reference
• RedisCache Reference
• MemoryCache Reference
• PropagateData Object Reference

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