/Cawfee

☕ Fast and simple example plugin system.

Primary LanguagePython

Cawfee

Cawfee is a fast, simple and extensible example plugin system.

  • ⚡ Extremely easy to use plugin system.
  • 🔗 Modular design.

Instructions

This assumes you have Git and Python installed.

git clone https://github.com/qtchaos/Cawfee.git
cd Cawfee
python main.py

Documentation

Check out the wiki, which explains how to set up a new plugin!

Contributing

Developer dependencies

  • yapf pip install yapf
  • toml pip install toml
  • mypy pip install mypy

Before committing, please run the following commands:

  • yapf . --recursive -i to ensure your code is formatted correctly.
  • mypy . to ensure your code is type checked correctly.