contributing.md

PyDeskUI Contributing Guide

Technology stack

• Python 3.10.2
• Tkinter 8.6

Development

1. Create virtual environment

# create new virtual environment , named .env_ui
python -m venv .env_ui

2. Activate virtual environment

For windows CMD

.\.env_ui\Scripts\activate.bat

For Mac bash

source .env_ui/bin/activate

other platform check: venv

For VS Code

1. Ctrl+Shift+P
2. Search python interpreter,choose Python: Select Interpreter
3. choose .env_ui environment
4. Open a new Command Prompt in VS Code terminal

3. Install dependencies

# install dependencies from requirements.txt
pip install -r requirements.txt

# install pydeskui by setup.py, delelop mode
python setup.py develop

4. Develop feature

cd src/pydeskui && python demo.py

Useful command

add a denpendency

 # install xxx-module
pip install xxx-module

 # generate requirements.txt
pip freeze > requirements.txt

remove a denpendency

 # uninstall xxx-module
pip uninstall xxx-module -y

 # generate requirements.txt
pip freeze > requirements.txt

setup.py

python setup.py build
python setup.py install
# clear setup
python setup.py clean --all

Build distribution

py -m pip install --upgrade build
py -m build

Publish to PyPI

# Admin mode installation
py -m pip install --upgrade twine
twine upload dist/*