Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.
/ plugins Public archive

A collection of Pyrogram plugins made by the community

License

Notifications You must be signed in to change notification settings

pyrogram/plugins

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Pyrogram Plugins

A collection of Pyrogram plugins made by the community

Pyrogram Smart Plugins allow users to create and easily share modular framework's components with minimal boilerplate code. This repository is meant to collect awesome Pyrogram plugins.

Using Plugins

  • Create a new folder in your working directory (e.g.: plugins).
  • Download and copy the desired plugin(s) into your plugins folder.
  • Enable plugins in your Client by telling Pyrogram to search on your folder with plugins=dict(root="plugins"):
    from pyrogram import Client
    
    app = Client("my_account", plugins=dict(root="plugins"))
  • Done! Run your client with app.run(), the plugins will be automatically loaded.

More details

Adding Plugins

  • Understand how Smart Plugins work.
  • Create an awesome plugin.
    • Make a folder for your plugin and choose a meaningful name.
    • Create a python file named the same inside your plugin folder.
    • If necessary, create a requirements.txt file and add all the dependencies your plugin needs.
  • Open a new Pull Request to propose adding your plugin inside the plugins directory.
    • Make sure you add a proper license and your name to it.
    • Also edit the readme to add the plugin in the list below.

Improving Plugins

You found a bug on a plugin or want to extend one? Or maybe you have ideas on how the plugin system can be improved? That's great! Open a new GitHub Issue and let's discuss about it.

Plugins Collection

Name Description Usage
haste, by delivrance Upload text to hastebin.com and send its link Reply to a group chat text message with !haste
welcome, by delivrance Greet new members with a welcome message Run and wait for new members to join your groups
eval, by Furoin Evaluate a Python expression and send the result Example: !eval 1+2+3
replace, by brightside Search and Replace a part of a message to suggest user if he meant something else Reply to a group chat text message with !r <old>/<new>