Metadata-Version: 2.1
Name: PyStark
Version: 0.2.4
Summary: An incomplete add-on extension to Pyrogram for personal use.
Home-page: https://github.com/StarkBotsIndustries/PyStark
Author: StarkBotsIndustries
Author-email: starkbotsindustries@gmail.com
License: GPLv3+
Download-URL: https://github.com/StarkBotsIndustries/PyStark/releases/latest
Project-URL: Documentation, https://pystark.readthedocs.io/
Project-URL: Community, https://t.me/StarkBots
Project-URL: Support, https://t.me/StarkBotsChat
Keywords: telegram,bot,pyrogram,python
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Natural Language :: English
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Education :: Testing
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE

# PyStark

> A star ⭐ from you means a lot

An incomplete add-on extension to [Pyrogram](https://pypi.org/project/Pyrogram), to create telegram bots a bit more easily.


## Documentation

Read the Documentation : https://pystark.readthedocs.io/

## 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.

1. **Default Plugins** - Any bot created using `pystark` will 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.


2. **Databases** - Both `postgres` and `redis` are ready to use once the environment variables are present. 
 
    To know more about **postgres** and **redis** usage in pystark - [Click Here](https://github.com/StarkBotsIndustries/PyStark/tree/master/pystark/database#databases)


3. **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 `Usage` section to know how.


4. **Easier** - There are multiple things that make it easier. 
   
- Start the bot using 2-lines of code.

```python
from pystark import Stark

Stark().activate()
```
- Easier to use methods and decorators


## Credits

- [Dan](https://github.com/delivrance) for his [Pyrogram](https://github.com/pyrogram/pyrogram) Library on top of which **pystark** works.

## Community and Support

Telegram Channel - **[StarkBots](https://t.me/StarkBots)**

Telegram Chat - **[StarkBotsChat](https://t.me/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+)](https://github.com/StarkBotsIndustries/PyStark/blob/master/LICENSE)


