Skip to main content

A multiclient bot that leverages pyrogram's smart plugins system.

Project description

pyrocatto bot

A multiclient bot that leverages pyrogram's smart plugins system.


Installation

With optional speedups (Installs packages like TgCrypto for Pyrogram):

  • pip install pyrocatto_bot[speedups]

Without optional speedups:

  • pip install pyrocatto_bot

Usage:

after setting up sessions and writing the configuration

Make sure to be in the directory the plugins are located in!

  • python -m pyrocatto_bot --session-dir <session_dir> --config <config_file>

For debugging:

  • python -m pyrocatto_bot --session-dir <session_dir> --config <config_file> --debug

Setting up sessions to use in configs:

For User account:

  • python -m pyrocatto_sg create-user-session --session-dir <session_dir>

For Bot account:

  • python -m pyrocatto_sg create-bot-session --session-dir <session_dir>

Example configuration:

user: &user
  plugins:
    root: 'plugins.user_plugins'
    include: Null
    exclude: Null

  addons:
    wheel_userids:
      - 1698923450

sessions: # name: {options}
  cattobot: {<<: *user}

Your own client sets:

#custom: &custom
  <<: *default # This line ensures non recursive inheritance from default client set
  plugins:
    root:
      - 'plugins.extra_plugins'
    include:
      - 'extra_plugin'
    exclude:
      - 'unwanted'

  addons:
    wheel_userids:
      - 12312421
      - 25235423
      - 21424111
      - ...

sessions:
  something: {<<: *custom}

A single value to modify:

extra_plugins: &extra_plugins
  root: 'extra_plugins'

sessions:
  something: {<<: *default, *extra_plugins}
  anotherthing: {<<: *default, plugins: {root: 'extra_plugins'}}

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

pyrocatto_bot-4.1.0.post1.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

pyrocatto_bot-4.1.0.post1-py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 3

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