Compare commits
1 Commits
v3.1.0
...
06b0f0cbce
Author | SHA1 | Date | |
---|---|---|---|
06b0f0cbce |
86
README.md
86
README.md
@@ -1,86 +1,2 @@
|
|||||||
<h1 align="center">LibBotUniversal</h1>
|
# LibBotUniversal
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/src/branch/master/LICENSE"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/libbot">
|
|
||||||
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal/releases/latest"><img alt="Gitea Release" src="https://img.shields.io/gitea/v/release/profitroll/LibBotUniversal?gitea_url=https%3A%2F%2Fgit.end-play.xyz"></a>
|
|
||||||
<a href="https://pypi.org/project/libbot/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/libbot"></a>
|
|
||||||
<a href="https://git.end-play.xyz/profitroll/LibBotUniversal"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Handy library for Telegram/Discord bots development.
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
There are different sub-packages available:
|
|
||||||
|
|
||||||
* pyrogram - Telegram bots with Pyrogram's fork "Pyrofork"
|
|
||||||
* pycord - Discord bots with Pycord
|
|
||||||
* speed - Performance improvements
|
|
||||||
* dev - Dependencies for package development purposes
|
|
||||||
|
|
||||||
You can freely choose any sub-package you want, as well as add multiple (comma-separated) or none at all.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# Only general features
|
|
||||||
pip install libbot
|
|
||||||
|
|
||||||
# Only with Pyrogram
|
|
||||||
pip install libbot[pyrogram]
|
|
||||||
|
|
||||||
# With Pycord and Performance improvements
|
|
||||||
pip install libbot[pycord,speed]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Pyrogram
|
|
||||||
|
|
||||||
```python
|
|
||||||
from libbot.pyrogram import PyroClient
|
|
||||||
|
|
||||||
def main():
|
|
||||||
client = PyroClient(scheduler=scheduler)
|
|
||||||
|
|
||||||
try:
|
|
||||||
client.run()
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
print("Shutting down...")
|
|
||||||
finally:
|
|
||||||
if client.scheduler is not None:
|
|
||||||
client.scheduler.shutdown()
|
|
||||||
exit()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
```
|
|
||||||
|
|
||||||
### Pycord
|
|
||||||
|
|
||||||
```python
|
|
||||||
from discord import Intents
|
|
||||||
from libbot import sync
|
|
||||||
from libbot.pycord import PycordBot
|
|
||||||
|
|
||||||
|
|
||||||
async def main():
|
|
||||||
intents = Intents.default()
|
|
||||||
bot = PycordBot(intents=intents)
|
|
||||||
|
|
||||||
bot.load_extension("cogs")
|
|
||||||
|
|
||||||
try:
|
|
||||||
await bot.start(sync.config_get("bot_token", "bot"))
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
logger.warning("Shutting down...")
|
|
||||||
await bot.close()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
loop = asyncio.get_event_loop()
|
|
||||||
loop.run_until_complete(main())
|
|
||||||
```
|
|
||||||
|
|
||||||
## Config examples
|
|
||||||
|
|
||||||
For bot config examples please check the examples directory. Without a valid config file, the bot won't start at all, so you need to make sure the correct config file is used.
|
|
||||||
|
@@ -1,13 +0,0 @@
|
|||||||
{
|
|
||||||
"locale": "en",
|
|
||||||
"debug": false,
|
|
||||||
"bot": {
|
|
||||||
"owners": [
|
|
||||||
0
|
|
||||||
],
|
|
||||||
"debug_guilds": [
|
|
||||||
0
|
|
||||||
],
|
|
||||||
"bot_token": ""
|
|
||||||
}
|
|
||||||
}
|
|
@@ -9,11 +9,11 @@ authors = [{ name = "Profitroll" }]
|
|||||||
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
description = "Universal bot library with functions needed for basic Discord/Telegram bot development."
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.8"
|
requires-python = ">=3.8"
|
||||||
license = { text = "GPLv3" }
|
license = { file = "LICENSE" }
|
||||||
classifiers = [
|
classifiers = [
|
||||||
"Development Status :: 3 - Alpha",
|
"Development Status :: 3 - Alpha",
|
||||||
"Intended Audience :: Developers",
|
"Intended Audience :: Developers",
|
||||||
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
"License :: OSI Approved :: MIT License",
|
||||||
"Operating System :: OS Independent",
|
"Operating System :: OS Independent",
|
||||||
"Programming Language :: Python :: 3.8",
|
"Programming Language :: Python :: 3.8",
|
||||||
"Programming Language :: Python :: 3.9",
|
"Programming Language :: Python :: 3.9",
|
||||||
|
@@ -1,11 +1,11 @@
|
|||||||
black==24.4.2
|
black==24.1.1
|
||||||
build==1.2.1
|
build==1.0.3
|
||||||
isort==5.13.2
|
isort==5.13.2
|
||||||
mypy==1.10.0
|
mypy==1.8.0
|
||||||
pylint==3.2.1
|
pylint==3.0.3
|
||||||
pytest-asyncio==0.23.7
|
pytest-asyncio==0.23.3
|
||||||
pytest-cov==5.0.0
|
pytest-cov==4.1.0
|
||||||
pytest==8.2.0
|
pytest==8.0.0
|
||||||
tox==4.15.0
|
tox==4.13.0
|
||||||
types-aiofiles==23.2.0.20240403
|
types-aiofiles==23.2.0.20240106
|
||||||
types-ujson==5.10.0.20240515
|
types-ujson==5.9.0.0
|
@@ -1,2 +1,2 @@
|
|||||||
apscheduler~=3.10.4
|
apscheduler~=3.10.4
|
||||||
py-cord~=2.5.0
|
py-cord~=2.4.1
|
@@ -1,2 +1,2 @@
|
|||||||
apscheduler~=3.10.4
|
apscheduler~=3.10.4
|
||||||
pyrofork~=2.3.21.post3
|
pyrofork~=2.3.18
|
@@ -1 +1 @@
|
|||||||
ujson~=5.10.0
|
ujson~=5.9.0
|
@@ -1,6 +1,6 @@
|
|||||||
__version__ = "3.1.0"
|
__version__ = "3.0.0"
|
||||||
__license__ = "GPL3"
|
__license__ = "GPL3"
|
||||||
__author__ = "Profitroll"
|
__author__ = "Profitroll"
|
||||||
|
|
||||||
from . import errors, i18n, pycord, pyrogram, sync
|
from . import i18n, pycord, pyrogram, sync
|
||||||
from .__main__ import *
|
from .__main__ import *
|
||||||
|
@@ -1 +0,0 @@
|
|||||||
from .config import ConfigKeyError, ConfigValueError
|
|
@@ -1,37 +0,0 @@
|
|||||||
from typing import Any, List, Optional, Union
|
|
||||||
|
|
||||||
|
|
||||||
class ConfigKeyError(Exception):
|
|
||||||
"""Raised when config key is not found.
|
|
||||||
|
|
||||||
### Attributes:
|
|
||||||
* key (`Union[str, List[str]]`): Missing config key.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, key: Union[str, List[str]]) -> None:
|
|
||||||
self.key: Union[str, List[str]] = key
|
|
||||||
super().__init__(
|
|
||||||
f"Config key {'.'.join(key) if isinstance(key, list) else key} is missing. Please set in your config file."
|
|
||||||
)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} is missing. Please set in your config file."
|
|
||||||
|
|
||||||
|
|
||||||
class ConfigValueError(Exception):
|
|
||||||
"""Raised when config key's value is invalid.
|
|
||||||
|
|
||||||
### Attributes:
|
|
||||||
* key (`Union[str, List[str]]`): Invalid config key.
|
|
||||||
* value (`Optional[Any]`): Key's correct value.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, key: Union[str, List[str]], value: Optional[Any] = None) -> None:
|
|
||||||
self.key: Union[str, List[str]] = key
|
|
||||||
self.value: Optional[Any] = value
|
|
||||||
super().__init__(
|
|
||||||
f"Config key {'.'.join(key) if isinstance(key, list) else key} has invalid value. {f'Must be {value}. ' if value else ''}Please set in your config file."
|
|
||||||
)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return f"Config key {'.'.join(self.key) if isinstance(self.key, list) else self.key} has invalid value. {f'Must be {self.value}. ' if self.value else ''}Please set in your config file."
|
|
@@ -1,6 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Dict, List, Union
|
from typing import Any, Dict, Union
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||||
@@ -29,7 +29,6 @@ class PycordBot(Bot):
|
|||||||
config_path: Union[str, Path] = Path("config.json"),
|
config_path: Union[str, Path] = Path("config.json"),
|
||||||
locales_root: Union[str, Path, None] = None,
|
locales_root: Union[str, Path, None] = None,
|
||||||
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
scheduler: Union[AsyncIOScheduler, BackgroundScheduler, None] = None,
|
||||||
*args,
|
|
||||||
**kwargs,
|
**kwargs,
|
||||||
):
|
):
|
||||||
if config is None:
|
if config is None:
|
||||||
@@ -39,11 +38,8 @@ class PycordBot(Bot):
|
|||||||
self.config = config
|
self.config = config
|
||||||
|
|
||||||
super().__init__(
|
super().__init__(
|
||||||
debug_guilds=(
|
debug_guilds=self.config["bot"]["debug_guilds"],
|
||||||
self.config["bot"]["debug_guilds"] if self.config["debug"] else None
|
|
||||||
),
|
|
||||||
owner_ids=self.config["bot"]["owners"],
|
owner_ids=self.config["bot"]["owners"],
|
||||||
*args,
|
|
||||||
**kwargs,
|
**kwargs,
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -52,7 +48,7 @@ class PycordBot(Bot):
|
|||||||
locales_root=(Path("locale") if locales_root is None else locales_root),
|
locales_root=(Path("locale") if locales_root is None else locales_root),
|
||||||
)
|
)
|
||||||
self.default_locale: str = self.bot_locale.default
|
self.default_locale: str = self.bot_locale.default
|
||||||
self.locales: Dict[str, Any] = self.bot_locale.locales
|
self.locales: dict = self.bot_locale.locales
|
||||||
|
|
||||||
self._ = self.bot_locale._
|
self._ = self.bot_locale._
|
||||||
self.in_all_locales = self.bot_locale.in_all_locales
|
self.in_all_locales = self.bot_locale.in_all_locales
|
||||||
|
Reference in New Issue
Block a user