https://github.com/slice/clyde
a pylint plugin for discord.py bots
https://github.com/slice/clyde
discord-py pylint
Last synced: about 1 year ago
JSON representation
a pylint plugin for discord.py bots
- Host: GitHub
- URL: https://github.com/slice/clyde
- Owner: slice
- License: mit
- Created: 2019-04-19T23:58:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-22T07:21:37.000Z (almost 7 years ago)
- Last Synced: 2025-01-21T16:24:08.162Z (about 1 year ago)
- Topics: discord-py, pylint
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
clyde
=====
clyde is a Pylint_ plugin for code that uses Discord.py_.
.. _Pylint: https://www.pylint.org
.. _Discord.py: https://discordpy.readthedocs.io/en/latest
Installation
------------
.. code:: sh
python3 -m pip install -U git+https://github.com/slice/clyde@master#egg=clyde
Usage
-----
Add the following to your ``~/.pylintrc``::
[MASTER]
load-plugins=clyde
Checkers
--------
missing-cog-listener (W7001)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Warns against missing ``@Cog.listener()`` decorators in cog event listeners.
Example:
.. code:: python3
class Sample(Cog):
async def on_message(self, msg):
...
+---------------------------------------------------------------------------------+
| **Caveat:** This checker only works for the built-in events dispatched by the |
| library. It's up to you to put the decorator on your own custom event handlers. |
+---------------------------------------------------------------------------------+