| Name | ezbotf JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Create own plugins for Telegram through this framework |
| upload_time | 2023-02-04 22:23:15 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 ftdot Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
telegram
framework
plugins
easy
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EzBot Framework (**In the development**)
This is a beautiful userbot framework for messangers that uses plugin system and have cool features, such as:
- Configurations (Your plugin may have config, such as "browser-to-use". Users of your plugin can change it)
- Translations (You can easily translate framework\plugins to any language by using TOML documents)
- Commands (You can create any command that can be called with prefixes)
- Argument Parser (You can easily add typed arguments to your command)
Currently, framework in the development. This is may cause some bugs or incorrect work of some functions, grammatical errors, undocumented things and other.
If you found any of this, describe it [there](/issues). [Also see here](#)
See more [on the documentation page](#)
## Contents
- [User Installation](#user-installation)
- - [By PIP](#by-pip)
- - [Manual Installation](#manual-installation)
- [Dev Installation](#dev-installation)
- [Quick Guide To Environment\Instances](#quick-guide-to-environmentinstances)
- - [Creating An Environment](#creating-an-environment)
- - [Creating Own Bot Instance](#creating-own-bot-instance)
- - [Setting Up Bot Instance](#setting-up-bot-instance)
- - [Run Your Bot Instance](#run-your-bot-instance)
- [Quick Guide To Plugins](#quick-guide-to-plugins)
- - [Installing a Plugin](#installing-a-plugin)
- - [Removing a Plugin](#removing-a-plugin)
- [Documentation](#documentation)
- - [Build Documentation](#build-documentation)
<!--
- [EzzBot - Better Place For Users](#ezzbot---better-place-for-users)
-->
## User Installation
**NOTE:** `EzBot Framework` only supports Python 3.10+ versions, I recommend to use Python 3.11.*
User Installation is just for simple users. This installation does not anticipate changes in the framework code.
If you want to contribute the code, see [Dev Installation](#dev-installation)
There are two ways to install this:
- By the Python PIP
- Manual
#### By PIP
Just enter command (WINDOWS):
```shell
pip install ezbotf
```
If your OS is Linux, enter this command:
```shell
pip3 install ezbotf
```
#### Manual Installation
Clone this repository:
```shell
git clone https://github.com/ftdot/ezbotf.git
```
**NOTE:** If you want to clone and use other (dev,unstable) branch, use this command instead of:
```shell
git clone --single-branch -b 1.0.0-dev https://github.com/ftdot/ezbotf.git
```
Enter the repo directory:
```shell
cd ezbotf
```
Run this command (WINDOWS):
```shell
pip install .
```
Or this for Linux:
```shell
pip3 install .
```
## Dev Installation
If you want to edit, contribute, debug, etc. the framework, you need to install `Editable` package.
This allows to edit code and use it in applications (as import) without uninstall\install scheme.
This feature is provided by **PyPI package manager**
Just go to [Manual User Installation](#manual-installation), but instead of last command, use it:
For Windows:
```shell
pip install --editable .
```
For Linux:
```shell
pip3 install --editable .
```
## Quick Guide To Environment\Instances
You can get help for the ezbotf by this command:
```shell
ezbotf -h
```
Also, you can get help with bot instances by this command:
```shell
ezbotf instance -h
```
#### Creating an Environment
You can use a EzBotF-CLI (installs with the EzBotF) to initialize new EzBotF environment:
```shell
ezbotf -i (NAME)
```
> **NOTE:** Replace `(NAME)` with name of environment you need. Name of environment = name of folder
Change current working directory to directory with the environment:
```shell
cd (NAME)
```
#### Creating Own Bot Instance
Create your instance (you can name it with name of account that you will be use):
```shell
ezbotf instance -n (NAME OF INSTANCE)
```
> **NOTE:** You can skip this step and use `default` instance name. This is comes with default environment settings
#### Setting Up Bot Instance
To set up your bot instance, you must have the `API ID` and `API HASH` credentials. You can get it from [my.telegram.org](https://my.telegram.org).
Go to "APPS". And if you don't have app - create and name it. After, you will get `API ID` and `API HASH`
> **NOTE:** Do not share your credentials! If your `API ID\API HASH` will be used for spamming, auto-subscribing, etc. **your account will be banned by Telegram!**
After you get `API ID` and `API HASH`, enter to your environment and enter this command:
```shell
ezbotf instance -s (NAME OF INSTANCE) --api-id (API ID) --api-hash
```
After you do this command, your instance will be successfully setup, and you can run it!
#### Run Your Bot Instance
After you set up environment, set up your bot instance - you can run it by this command:
```shell
ezbotf instance -r (NAME OF INSTANCE)
```
> **NOTE:** By first run, bot instance will ask your telegram credentials. Don't scare, to these credentials nobody have access, only you
## Quick Guide To Plugins
You can get help for the plugins by this command:
```shell
ezbotf plugin -h
```
#### Installing a Plugin
To install plugin, firstly, you need to download it to environment directory.
After you install it, you can type this command:
```shell
ezbotf plugin -i (INSTANCE NAME) -I (PATH TO PLUGIN)
```
> **NOTE:** Path to plugin must ends with ".plugin.zip"
#### Removing a Plugin
To remove a plugin, you can simply type:
```shell
ezbotf plugin -i (INSTANCE NAME) -r (NAME OF PLUGIN)
```
> **NOTE:** Plugin name = plugin directory name, or name without ".plugin.zip" suffix
## Documentation
(There must be link to the documentation)
#### Build Documentation
For first, you need to clone this repository and go to this directory.
If you are not cloned this repo, [see this](#manual-installation)
Enter the `docs` repository:
```shell
cd docs
```
Install requirements:
```shell
pip install -r requirements.txt
```
**WARNING:** Is required to install and use **Make** utility.
Or, on Windows you can use **make.bat** and skip this warning
Build **HTML** docs via **Make**:
```shell
make html
```
<!--
## **EzzBot** - Better Place For Users
**EzzBot** - Is an application-overlay of the EzBot Framework for all platforms (including **Android**) with the GUI and some cool features.
I recommend to use it if you are is user.
At the current moment, this project in the closed development. To get news about it, you can watch [this repo](https://github.com/ftdot/ezbot)
-->
Raw data
{
"_id": null,
"home_page": "",
"name": "ezbotf",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "telegram,framework,plugins,easy",
"author": "",
"author_email": "ftdot <ftdoot@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a2/b9/4ef717a8dbfe5aecf633e7d2f35e543406bdc787cecd1cd5d19eff40dfa5/ezbotf-1.0.0.tar.gz",
"platform": null,
"description": "\r\n# EzBot Framework (**In the development**)\r\n\r\nThis is a beautiful userbot framework for messangers that uses plugin system and have cool features, such as:\r\n- Configurations (Your plugin may have config, such as \"browser-to-use\". Users of your plugin can change it)\r\n- Translations (You can easily translate framework\\plugins to any language by using TOML documents)\r\n- Commands (You can create any command that can be called with prefixes)\r\n- Argument Parser (You can easily add typed arguments to your command)\r\n\r\nCurrently, framework in the development. This is may cause some bugs or incorrect work of some functions, grammatical errors, undocumented things and other.\r\nIf you found any of this, describe it [there](/issues). [Also see here](#)\r\n\r\nSee more [on the documentation page](#)\r\n\r\n\r\n## Contents\r\n\r\n- [User Installation](#user-installation)\r\n- - [By PIP](#by-pip)\r\n- - [Manual Installation](#manual-installation)\r\n\r\n- [Dev Installation](#dev-installation)\r\n\r\n- [Quick Guide To Environment\\Instances](#quick-guide-to-environmentinstances)\r\n- - [Creating An Environment](#creating-an-environment)\r\n- - [Creating Own Bot Instance](#creating-own-bot-instance)\r\n- - [Setting Up Bot Instance](#setting-up-bot-instance)\r\n- - [Run Your Bot Instance](#run-your-bot-instance)\r\n\r\n- [Quick Guide To Plugins](#quick-guide-to-plugins)\r\n- - [Installing a Plugin](#installing-a-plugin)\r\n- - [Removing a Plugin](#removing-a-plugin)\r\n\r\n- [Documentation](#documentation)\r\n- - [Build Documentation](#build-documentation)\r\n\r\n<!--\r\n- [EzzBot - Better Place For Users](#ezzbot---better-place-for-users)\r\n-->\r\n\r\n\r\n## User Installation\r\n\r\n**NOTE:** `EzBot Framework` only supports Python 3.10+ versions, I recommend to use Python 3.11.*\r\n\r\nUser Installation is just for simple users. This installation does not anticipate changes in the framework code.\r\nIf you want to contribute the code, see [Dev Installation](#dev-installation)\r\n\r\nThere are two ways to install this:\r\n- By the Python PIP\r\n- Manual\r\n\r\n\r\n#### By PIP\r\n\r\nJust enter command (WINDOWS):\r\n```shell\r\npip install ezbotf\r\n```\r\n\r\nIf your OS is Linux, enter this command:\r\n```shell\r\npip3 install ezbotf\r\n```\r\n\r\n\r\n#### Manual Installation\r\n\r\nClone this repository:\r\n```shell\r\ngit clone https://github.com/ftdot/ezbotf.git\r\n```\r\n\r\n**NOTE:** If you want to clone and use other (dev,unstable) branch, use this command instead of:\r\n```shell\r\ngit clone --single-branch -b 1.0.0-dev https://github.com/ftdot/ezbotf.git\r\n```\r\n\r\nEnter the repo directory:\r\n```shell\r\ncd ezbotf\r\n```\r\n\r\nRun this command (WINDOWS):\r\n```shell\r\npip install .\r\n```\r\n\r\nOr this for Linux:\r\n```shell\r\npip3 install .\r\n```\r\n\r\n## Dev Installation\r\n\r\nIf you want to edit, contribute, debug, etc. the framework, you need to install `Editable` package.\r\nThis allows to edit code and use it in applications (as import) without uninstall\\install scheme.\r\nThis feature is provided by **PyPI package manager**\r\n\r\nJust go to [Manual User Installation](#manual-installation), but instead of last command, use it:\r\n\r\nFor Windows:\r\n```shell\r\npip install --editable .\r\n```\r\n\r\nFor Linux:\r\n```shell\r\npip3 install --editable .\r\n```\r\n\r\n\r\n## Quick Guide To Environment\\Instances\r\n\r\nYou can get help for the ezbotf by this command:\r\n```shell\r\nezbotf -h\r\n```\r\n\r\nAlso, you can get help with bot instances by this command:\r\n```shell\r\nezbotf instance -h\r\n```\r\n\r\n\r\n#### Creating an Environment\r\n\r\nYou can use a EzBotF-CLI (installs with the EzBotF) to initialize new EzBotF environment:\r\n```shell\r\nezbotf -i (NAME)\r\n```\r\n> **NOTE:** Replace `(NAME)` with name of environment you need. Name of environment = name of folder\r\n\r\nChange current working directory to directory with the environment:\r\n```shell\r\ncd (NAME)\r\n```\r\n\r\n\r\n#### Creating Own Bot Instance\r\n\r\nCreate your instance (you can name it with name of account that you will be use):\r\n```shell\r\nezbotf instance -n (NAME OF INSTANCE)\r\n```\r\n> **NOTE:** You can skip this step and use `default` instance name. This is comes with default environment settings\r\n\r\n\r\n#### Setting Up Bot Instance\r\n\r\nTo set up your bot instance, you must have the `API ID` and `API HASH` credentials. You can get it from [my.telegram.org](https://my.telegram.org).\r\nGo to \"APPS\". And if you don't have app - create and name it. After, you will get `API ID` and `API HASH`\r\n\r\n> **NOTE:** Do not share your credentials! If your `API ID\\API HASH` will be used for spamming, auto-subscribing, etc. **your account will be banned by Telegram!**\r\n\r\nAfter you get `API ID` and `API HASH`, enter to your environment and enter this command:\r\n```shell\r\nezbotf instance -s (NAME OF INSTANCE) --api-id (API ID) --api-hash\r\n```\r\n\r\nAfter you do this command, your instance will be successfully setup, and you can run it!\r\n\r\n\r\n#### Run Your Bot Instance\r\n\r\nAfter you set up environment, set up your bot instance - you can run it by this command:\r\n```shell\r\nezbotf instance -r (NAME OF INSTANCE)\r\n```\r\n> **NOTE:** By first run, bot instance will ask your telegram credentials. Don't scare, to these credentials nobody have access, only you\r\n\r\n\r\n## Quick Guide To Plugins\r\n\r\nYou can get help for the plugins by this command:\r\n```shell\r\nezbotf plugin -h\r\n```\r\n\r\n\r\n#### Installing a Plugin\r\n\r\nTo install plugin, firstly, you need to download it to environment directory.\r\nAfter you install it, you can type this command:\r\n```shell\r\nezbotf plugin -i (INSTANCE NAME) -I (PATH TO PLUGIN)\r\n```\r\n> **NOTE:** Path to plugin must ends with \".plugin.zip\"\r\n\r\n\r\n#### Removing a Plugin\r\n\r\nTo remove a plugin, you can simply type:\r\n```shell\r\nezbotf plugin -i (INSTANCE NAME) -r (NAME OF PLUGIN)\r\n```\r\n> **NOTE:** Plugin name = plugin directory name, or name without \".plugin.zip\" suffix\r\n\r\n\r\n## Documentation\r\n\r\n(There must be link to the documentation)\r\n\r\n\r\n#### Build Documentation\r\n\r\nFor first, you need to clone this repository and go to this directory.\r\nIf you are not cloned this repo, [see this](#manual-installation)\r\n\r\nEnter the `docs` repository:\r\n```shell\r\ncd docs\r\n```\r\n\r\nInstall requirements:\r\n```shell\r\npip install -r requirements.txt\r\n```\r\n\r\n**WARNING:** Is required to install and use **Make** utility.\r\nOr, on Windows you can use **make.bat** and skip this warning\r\n\r\nBuild **HTML** docs via **Make**:\r\n```shell\r\nmake html\r\n```\r\n\r\n<!--\r\n## **EzzBot** - Better Place For Users\r\n\r\n**EzzBot** - Is an application-overlay of the EzBot Framework for all platforms (including **Android**) with the GUI and some cool features.\r\nI recommend to use it if you are is user.\r\n\r\nAt the current moment, this project in the closed development. To get news about it, you can watch [this repo](https://github.com/ftdot/ezbot)\r\n-->\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 ftdot Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Create own plugins for Telegram through this framework",
"version": "1.0.0",
"split_keywords": [
"telegram",
"framework",
"plugins",
"easy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f757ebdd682705efa4251029ed691c7c67b7946d91636ceaf29edd50e4aaf12",
"md5": "6386558c939d48d3e931516d12e23986",
"sha256": "54c09932bee21b410e7bad7a43675f46b18823bd565c9ffd399163a16fb20d16"
},
"downloads": -1,
"filename": "ezbotf-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6386558c939d48d3e931516d12e23986",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 37153,
"upload_time": "2023-02-04T22:23:13",
"upload_time_iso_8601": "2023-02-04T22:23:13.278793Z",
"url": "https://files.pythonhosted.org/packages/9f/75/7ebdd682705efa4251029ed691c7c67b7946d91636ceaf29edd50e4aaf12/ezbotf-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a2b94ef717a8dbfe5aecf633e7d2f35e543406bdc787cecd1cd5d19eff40dfa5",
"md5": "946aa411f625d1cd14c3be9d7e38b648",
"sha256": "d6f461b819b2c2ed3ae90c5b479b9b2e28e76daaf42c63c54b0730f8f99c8632"
},
"downloads": -1,
"filename": "ezbotf-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "946aa411f625d1cd14c3be9d7e38b648",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 33049,
"upload_time": "2023-02-04T22:23:15",
"upload_time_iso_8601": "2023-02-04T22:23:15.526601Z",
"url": "https://files.pythonhosted.org/packages/a2/b9/4ef717a8dbfe5aecf633e7d2f35e543406bdc787cecd1cd5d19eff40dfa5/ezbotf-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-04 22:23:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "ezbotf"
}
