PyStark
A star
⭐ from you means a lot
An incomplete add-on extension to Pyrogram, to create telegram bots a bit more easily.
Intended for personal use
I do NOT 'especially' recommend you to use it.
Installation (using pip)
pip3 install pystark
What's the main purpose?
There are some things that are common in every bot. This makes it a bit simple to generate a boilerplate and ease overall creation.
-
Default Plugins - Any bot created using
pystarkwill automatically have some commands like /start, /help, /about and /id.Of course that can be turned off using default_plugins=False in the main function.
-
Databases - Both
postgresandredisare ready to use once the environment variables are present.To know more about postgres and redis usage in pystark - Click Here
-
Boilerplate - You can generate a boilerplate with all the files you will need using our command line utility. Optionally, you can generate it with Heroku Support (app.json, Procfile, etc). Please scroll down below to
Usagesection to know how. -
Easier - There are multiple things that make it easier.
- Start the bot using 2-lines of code.
from pystark import Stark
Stark().activate()
- Easier to use methods and decorators
Usage
-
Creating Boilerplate Code
You can generate a boilerplate to set up the common files you need. You can also choose to have added heroku support which will create app.json, Procfile, etc. This can be done using the command-line utility.
Run below command
pystark
cd into the directory where you want to create the boilerplate folder. Then run below command.
pystark --boilerplate
To create boilerplate with Heroku Support
pystark --boilerplate-heroku
Boilerplate folder will be created with a plugins directory and some other necessary files
-
Making Basic Changes to the folder
- Filling variables - Fill the mandatory values in
.envfile. (Step only if non-heroku boilerplate is created) - Changing Text for Messages - Go to 'data.py' and change string values as it suits you.
-
Create your own plugins
You can create plugins and add it in plugins folder, and it'll be automatically loaded while starting the bot. Of course, you need Python knowledge to create awesome plugins.
# Import class 'Stark' in top of every plugin
from pystark import Stark, Message
# use 'Stark.cmd' decorator to create commands
# @Stark.cmd('name', owner_only=False, extra_filters=None, group=0) - defaults
@Stark.cmd('sample') # or @Stark.command('sample')
async def sample_function(bot: Stark, msg: Message):
# 'msg.react()' is 'msg.reply()' with del_in added argument
await msg.react('This will be the reply when /sample is sent to the bot.')
-
Run the bot
Heroku - Create a repository and tap on Deploy Heroku Button. Fill the values, click deploy and wait for 2 minutes and done.
Local Deploy - Make sure you filled variables in .env as told above. Run the bot.py file using command python3 bot.py and there you go.
Credits and Library
Community and Support
Telegram Channel - StarkBots
Telegram Chat - StarkBotsChat
Copyright and License
-
Copyright (C) 2021-2022 Stark Bots <https://github.com/StarkBotsIndustries>
-
Licensed under the terms of GNU General Public License v3 or later (GPLv3+)
6 Sep 14, 2022
7.3k Jan 1, 2023
47 Dec 29, 2022
5 Oct 6, 2022
32 Dec 15, 2022
15 Feb 11, 2022
7 May 21, 2022
164 Nov 12, 2022
79 Dec 20, 2022
32 Dec 24, 2022
4 Dec 08, 2021
6 Oct 27, 2022
2.6k Jan 05, 2023
150 Jan 04, 2023
4 Apr 03, 2022
14 Oct 06, 2022
117 Dec 29, 2022
4 Feb 06, 2022
6.8k Jan 04, 2023
5 Feb 01, 2022
26 Nov 30, 2022
3 Nov 12, 2021
14 Sep 03, 2022
27 May 13, 2022
4 Sep 23, 2022
9 Dec 10, 2022
17 Dec 06, 2022
3 Nov 09, 2022