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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pyrocatto_bot-4.1.0.post1.tar.gz.

File metadata

  • Download URL: pyrocatto_bot-4.1.0.post1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.5 Linux/6.4.15-200.fc38.x86_64

File hashes

Hashes for pyrocatto_bot-4.1.0.post1.tar.gz
Algorithm Hash digest
SHA256 971eb820a00b7f7b4fa3dda92a695df543ae6c069ac421bece88cf25394379d3
MD5 80ca353f7f92ffdaa72d20202f68bc0f
BLAKE2b-256 9017e8749905d425f6e5c8dea42831cd58f62c573b49236a44d934c50d26c44b

See more details on using hashes here.

File details

Details for the file pyrocatto_bot-4.1.0.post1-py3-none-any.whl.

File metadata

  • Download URL: pyrocatto_bot-4.1.0.post1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.5 Linux/6.4.15-200.fc38.x86_64

File hashes

Hashes for pyrocatto_bot-4.1.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 a7f6211816404e971ed3c983624b6442e8b1b46dd2ed0d2711508da0b9a03a4b
MD5 5a83c8d80a798676c0bb7ca5651ee520
BLAKE2b-256 9476d8798793bbf138af3828469102d87add526dcbc65e7d4a51eaf234f6dc6f

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