mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
b457f8d1c1
* feat: add deprecation warning when importing shared libs * enhance(downloader): add shared libs deprecation warns * enhance: add deprecation warning when (re)loading cogs * docs(downloader): add deprecation note about shared libs * chore(changelog): add towncrier entries * style: split long tuple unpacks in multiple lines * fix: argument to `humanize_list` has to be a sequence
103 lines
2.9 KiB
ReStructuredText
103 lines
2.9 KiB
ReStructuredText
.. downloader framework reference
|
|
|
|
Downloader Framework
|
|
====================
|
|
|
|
Info.json
|
|
*********
|
|
|
|
The optional info.json file may exist inside every package folder in the repo,
|
|
as well as in the root of the repo. The following sections describe the valid
|
|
keys within an info file (and maybe how the Downloader cog uses them).
|
|
|
|
Keys common to both repo and cog info.json (case sensitive)
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
- ``author`` (list of strings) - list of names of authors of the cog or repo.
|
|
|
|
- ``description`` (string) - A long description of the cog or repo. For cogs, this
|
|
is displayed when a user executes ``!cog info``.
|
|
|
|
- ``install_msg`` (string) - The message that gets displayed when a cog
|
|
is installed or a repo is added
|
|
|
|
.. tip:: You can use the ``[p]`` key in your string to use the prefix
|
|
used for installing.
|
|
|
|
- ``short`` (string) - A short description of the cog or repo. For cogs, this info
|
|
is displayed when a user executes ``!cog list``
|
|
|
|
Keys specific to the cog info.json (case sensitive)
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
- ``min_bot_version`` (string) - Min version number of Red in the format ``MAJOR.MINOR.MICRO``
|
|
|
|
- ``max_bot_version`` (string) - Max version number of Red in the format ``MAJOR.MINOR.MICRO``,
|
|
if ``min_bot_version`` is newer than ``max_bot_version``, ``max_bot_version`` will be ignored
|
|
|
|
- ``min_python_version`` (list of integers) - Min version number of Python
|
|
in the format ``[MAJOR, MINOR, PATCH]``
|
|
|
|
- ``hidden`` (bool) - Determines if a cog is visible in the cog list for a repo.
|
|
|
|
- ``disabled`` (bool) - Determines if a cog is available for install.
|
|
|
|
- ``required_cogs`` (map of cogname to repo URL) - A map of required cogs that this cog depends on.
|
|
Downloader will not deal with this functionality but it may be useful for other cogs.
|
|
|
|
- ``requirements`` (list of strings) - list of required libraries that are
|
|
passed to pip on cog install. ``SHARED_LIBRARIES`` do NOT go in this
|
|
list.
|
|
|
|
- ``tags`` (list of strings) - A list of strings that are related to the
|
|
functionality of the cog. Used to aid in searching.
|
|
|
|
- ``type`` (string) - Optional, defaults to ``COG``. Must be either ``COG`` or
|
|
``SHARED_LIBRARY``. If ``SHARED_LIBRARY`` then ``hidden`` will be ``True``.
|
|
|
|
.. warning::
|
|
Shared libraries are deprecated since version 3.2 and are marked for removal in version 3.3.
|
|
|
|
API Reference
|
|
*************
|
|
|
|
.. automodule:: redbot.cogs.downloader.json_mixins
|
|
|
|
.. autoclass RepoJSONMixin
|
|
:members
|
|
|
|
.. automodule:: redbot.cogs.downloader.installable
|
|
|
|
Installable
|
|
^^^^^^^^^^^
|
|
|
|
.. autoclass:: Installable
|
|
:members:
|
|
|
|
InstalledModule
|
|
^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: InstalledModule
|
|
:members:
|
|
|
|
.. automodule:: redbot.cogs.downloader.repo_manager
|
|
|
|
Repo
|
|
^^^^
|
|
|
|
.. autoclass:: Repo
|
|
:members:
|
|
|
|
Repo Manager
|
|
^^^^^^^^^^^^
|
|
|
|
.. autoclass:: RepoManager
|
|
:members:
|
|
|
|
Exceptions
|
|
^^^^^^^^^^
|
|
|
|
.. automodule:: redbot.cogs.downloader.errors
|
|
:members:
|
|
|