From bb8a3bb1910e16b729fd6ac423fe4dd6de3cc22f Mon Sep 17 00:00:00 2001 From: Snazzah Date: Mon, 20 Apr 2020 03:34:45 -0500 Subject: [PATCH] Service deprecation notices --- README.md | 6 ++++-- dbots/service.py | 4 ++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 32ee2b0..1ac765e 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ See more examples [here](/examples). - [bots.ondiscord.xyz](https://bots.ondiscord.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.BotsOnDiscord)) - [carbonitex.net](https://www.carbonitex.net/Discord/bots) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.Carbon)) - [cloud-botlist.xyz](https://cloud-botlist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.CloudBotList)) - - [cloudlist.xyz](https://cloudlist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.CloudList)) + - *[cloudlist.xyz](https://cloudlist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.CloudList)) - [dblista.pl](https://dblista.pl) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DBLista)) - [discord.bots.gg](https://discord.bots.gg) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordBotsGG)) - [discordapps.dev](https://discordapps.dev) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordAppsDev)) @@ -121,7 +121,7 @@ See more examples [here](/examples). - [discordbotlist.com](https://discordbotlist.com) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordBotList)) - [discordbot.world](https://discordbot.world) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordBotWorld)) - [discordextremelist.xyz](https://discordextremelist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordExtremeList)) - - [divinediscordbots.com](https://divinediscordbots.com) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DivineDiscordBots)) + - *[divinediscordbots.com](https://divinediscordbots.com) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DivineDiscordBots)) - [glennbotlist.xyz](https://glennbotlist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.GlennBotList)) - [lbots.org](https://lbots.org) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.LBots)) - [listmybots.com](https://listmybots.com) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.ListMyBots)) @@ -131,6 +131,8 @@ See more examples [here](/examples). - [wonderbotlist.com](https://wonderbotlist.com) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.WonderBotList)) - [yabl.xyz](yabl.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.YABL)) +*These services (cloudlist & divinediscordbots) are shutting down. Any service objects and functions towards these services will be removed in the next major release. + ### Adding Custom Services You can add custom services by extending from the base service class (`dbots.Service`) and overriding the `_post` and `aliases` method. Make sure to add the custom service class to the service keymap. (`dbots.Service.SERVICE_KEYMAP`) An example of adding a custom service can be shown [here](/examples/custom_service.py). diff --git a/dbots/service.py b/dbots/service.py index 8018699..08e88a8 100644 --- a/dbots/service.py +++ b/dbots/service.py @@ -581,6 +581,8 @@ def get_bot(self, bot_id: str) -> HTTPResponse: class CloudList(Service): """ Represents the Cloud List service. + + .. warning:: This service is deprecated and will be removed in the next major release. .. seealso:: - `Cloud List Website `_ @@ -1317,6 +1319,8 @@ def get_widget_url(self, bot_id: str, **query) -> str: class DivineDiscordBots(Service): """ Represents the Divine Discord Bots service. + + .. warning:: This service is deprecated and will be removed in the next major release. .. seealso:: - `Divine Discord Bots Website `_