diff --git a/README.md b/README.md index df08bb4..62a7b8f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

- The easiest way to use Boticord API in Python. + The easiest way to use BotiCord API in Python. ยท Docs @@ -20,9 +20,9 @@

Features

* Object-oriented -* Full Boticord API Coverage +* Full BotiCord API Coverage * Modern Pythonic API using `async`/`await` syntax -* Boticord Webhooks +* BotiCord Webhooks * It is not necessary to use any particular library to interact with the Discord API.

Installation

@@ -32,11 +32,11 @@ Enter one of these commands to install the library: ``` - pip install boticordpy +pip install boticordpy ``` ``` - python3 -m pip install boticordpy +python3 -m pip install boticordpy ``` Or just clone the repo: https://github.com/boticord/boticordpy @@ -48,29 +48,29 @@ You can find other examples in an examples folder. **Discord.py Autopost example** ```py - from discord.ext import commands +from discord.ext import commands - from boticordpy import BoticordClient +from boticordpy import BoticordClient - bot = commands.Bot(command_prefix="!") +bot = commands.Bot(command_prefix="!") - async def get_stats(): - return {"servers": len(bot.guilds), "shards": 0, "users": len(bot.users)} +async def get_stats(): + return {"servers": len(bot.guilds), "shards": 0, "users": len(bot.users)} - async def on_success_posting(): - print("stats posting successfully") +async def on_success_posting(): + print("stats posting successfully") - boticord_client = BoticordClient("your_api_token") - autopost = ( - boticord_client.autopost() - .init_stats(get_stats) - .on_success(on_success_posting) - .start() - ) +boticord_client = BoticordClient("your_api_token") +autopost = ( + boticord_client.autopost() + .init_stats(get_stats) + .on_success(on_success_posting) + .start() +) - bot.run("bot token") +bot.run("bot token") ```

Links

@@ -78,9 +78,9 @@ You can find other examples in an examples folder. * [PyPi](https://pypi.org/project/boticordpy) * [Documentation](https://py.boticord.top) * [Github](https://github.com/boticord/boticordpy) -* [Boticord](https://boticord.top/) +* [BotiCord](https://boticord.top/) * [Support](https://boticord.top/discord)

Help

-If You need any help we recommend you to check the documentation. You can find us [here](https://bcord.cc/support). Main developer is `Marakarka#0575` +If You need any help we recommend you to check the documentation. You can find us [here](https://bcord.cc/support). Main developer is **[Marakarka](https://boticord.top/profile/585766846268047370)** diff --git a/boticordpy/__init__.py b/boticordpy/__init__.py index 5f69d3e..f74a826 100644 --- a/boticordpy/__init__.py +++ b/boticordpy/__init__.py @@ -10,7 +10,7 @@ __title__ = 'boticordpy' __author__ = 'Marakarka' __license__ = 'MIT' __copyright__ = 'Copyright 2022 Marakarka' -__version__ = '2.0.2' +__version__ = '2.0.3' from .client import BoticordClient from .webhook import Webhook diff --git a/boticordpy/client.py b/boticordpy/client.py index 7226524..79ad978 100644 --- a/boticordpy/client.py +++ b/boticordpy/client.py @@ -6,7 +6,7 @@ from .autopost import AutoPost class BoticordClient: - """Represents a client that can be used to interact with the Boticord API. + """Represents a client that can be used to interact with the BotiCord API. Note: Remember that every http method can return http exception. diff --git a/boticordpy/http.py b/boticordpy/http.py index b871a94..504224e 100644 --- a/boticordpy/http.py +++ b/boticordpy/http.py @@ -7,11 +7,11 @@ from . import exceptions class HttpClient: """ - Represents an HTTP client sending HTTP requests to the Top.gg API. + Represents an HTTP client sending HTTP requests to the BotiCord API. Args: token (:obj:`str`) - Your bot's Boticord API Token. + Your bot's BotiCord API Token. Keyword Arguments: session: `aiohttp session`_ diff --git a/boticordpy/types.py b/boticordpy/types.py index 1a1f549..db91f92 100644 --- a/boticordpy/types.py +++ b/boticordpy/types.py @@ -93,7 +93,7 @@ class SingleComment(ApiData): class Bot(ApiData): - """This model represents a bot, returned from the Boticord API""" + """This model represents a bot, returned from the BotiCord API""" id: str """Bot's Id""" @@ -136,7 +136,7 @@ class Bot(ApiData): long_description: typing.Optional[str] """Bot's long description""" - badge: typing.Optional[int] + badge: typing.Optional[str] """Bot's badge""" stats: dict diff --git a/boticordpy/webhook.py b/boticordpy/webhook.py index 75d3531..f6bbcc0 100644 --- a/boticordpy/webhook.py +++ b/boticordpy/webhook.py @@ -8,7 +8,7 @@ import aiohttp class Webhook: - """Represents a client that can be used to work with Boticord Webhooks. + """Represents a client that can be used to work with BotiCord Webhooks. IP of the server - your machine IP. (`0.0.0.0`) Args: diff --git a/docs/source/api.rst b/docs/source/api.rst index 3ccb5b2..cf0c356 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -6,7 +6,7 @@ API Reference ############# -API Reference for the BoticordPY Module +API Reference for the boticordpy Module Index: diff --git a/docs/source/index.rst b/docs/source/index.rst index cd343cf..63629a7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ -Welcome to BoticordPy's documentation! +Welcome to boticordpy's documentation! ====================================== -This is a documentation for wrapper for Boticord API. +This is a documentation for wrapper for BotiCord API. ====================================== @@ -19,5 +19,5 @@ Links * :ref:`search` * `PyPi `_ * `GitHub `_ -* `Boticord `_ -* `Boticord Support `_ +* `BotiCord `_ +* `BotiCord Support `_ diff --git a/setup.py b/setup.py index 8232cf2..7d5bd1b 100644 --- a/setup.py +++ b/setup.py @@ -37,11 +37,11 @@ setup( packages=find_packages(), version=version, python_requires=">= 3.6", - description="A Python wrapper for Boticord API", + description="A Python wrapper for BotiCord API", long_description=README, long_description_content_type="text/markdown", url="https://github.com/boticord/boticordpy", - author="KerdokuCat", + author="Marakarka", author_email="support@kerdoku.top", license="MIT", classifiers=[