Welcome to IRC API’s documentation!

Description

IRC API is a small API to make Python IRC bots. This API is based on decorators to make commands like the cog module in discord.py.

You can read the code source on Github.

If you encounter any issue feel free to open one in Github.

Installation

To install IRC API, you should use pip install irc-api.

Licence

This project is under GNU General Public Licence v3.0 or later (GPLv3+). Please see LICENCE for more informations

Content

• Home
• Tutorials
  • My first IRC bot
  • SASL auth
  • Logging
  • Make a command
  • Import commands into a bot
  • Module of commands
  • Auto-generated assistance
• Bot
  • Classes
    • Bot
      • Bot.__init__()
      • Bot.add_command()
      • Bot.add_commands()
      • Bot.send()
      • Bot.start()
    • BotCommand
  • Functions
    • parse()
    • convert()
    • check_args()
• Commands
  • Decorators
    • command()
    • channel()
    • every()
    • on()
    • user()
• History
  • Classes
    • History
      • History.add()
      • History.get()
• IRC
  • Classes
    • IRC
      • IRC.__init__()
      • IRC.connection()
      • IRC.join()
      • IRC.receive()
      • IRC.send()
      • IRC.waitfor()
• Message
  • Classes
    • Message