wasi-master / dpylint

An extension for linting discord.py with pylint

dpylint

An pylint extension for linting discord.py
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

dpylint is a pylint extension that lints python code written for a discord bot
For a demo see demo.md

Built With

• python
• pylint

Getting Started

To install dpylint:

Prerequisites

You'll need to have python and pylint installed in order to use the extension

Installation

• Installing via pip

  1. Directly installing via pip (Recommended)

     pip install dpylint

  2. Installing using pip and git

     pip install git+https://github.com/wasi-master/dpylint.git

• Cloning then installing

  1. Clone the repo

     git clone https://github.com/wasi-master/dpylint.git

  2. Install using pip

     pip install .

Usage

Create a new file called .pylintrc and add this to that file

[MASTER]

load-plugins=dpylint

For more examples such as vscode installation, usage without pylintrc file, please refer to the Documentation

Roadmap

See the todo list for a list of features yet to be added(and known issues). Also see the open issues issues.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/wasi-master/dpylint

Discord: Wasi Master#6969

Email: [e-mail]

Acknowledgements

• Cyrus from the official discord.py server

  • For the event checking idea

• Gnome from the official discord.py server

  • For the idea to check for aliases. e.g. ctx.channel.send instead of ctx.send

• proguy (bobo yoda) from the official discord.py server

  • For the idea to check for client instead of bot

• Hay (Kekka)

  • For the idea to check for misleading variable names for discord.User and discord.Member