CONTRIBUTING.md

Welcome to the contributing guide

You are welcome to:

1. open/solve Issues
2. open Pull Requests
3. Propose Features/Ideas in the Discussion tab.

Issues

Always add a appropiate label to your Issue

Pull Requests

1. Open a PR only for a single topic. Do not mix chnages from diffrent Issues/Features in on PR!
2. Describe your chnages and what they do.
3. Before you commit run:
   • black as a code formatter. Command: black ./,
   • flake8 for basic linting. Command: flake8 ./,
   • isort for sorting new imports. Command:isort .

Want to contribute but dont know where to start?

We have list of Features/Issues you could implement/fix.
Filter the Discussions or Issues for the "For Contributers" label to find them.

Instructions for Developers

Building from source

1. python -m venv venv
2. source venv/bin/activate
3. pip install -r requirements.txt

PyPi: activate: source venv/bin/activate build: python -m build install: pip install liewa uninstall: pip uninstall liewa

Linux: activate: source venv/bin/activate build: ./build.sh install: sudo dpkg -i liewa.deb uninstall: sudo dpkg -P liewa

Windows: activate: source venv/bin/activate build: pyinstaller app.spec compile: Compile the winCompiler.iss file with the Inno Software. install: Execute liewaInstaller.exe

MacOS: activate: source venv/bin/activate build: pyinstaller app.spec build dmg: ./builddmg.sh install by drag and drop from dmg