Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 2.51 KB
Raw

Contributing

Contributions are welcome. Issues, ideas and pull requests are all appreciated.

Dev Setup

1. Clone Repo

git clone https://github.com/Crozzers/screen_brightness_control
cd screen_brightness_control

2.1 Setting up a Venv in the Project Folder

If you're using VSCode, open the command palette (Ctrl + Shift + P) and search for the Python: Create Environment option. This will create the venv in the project folder and install dependencies for you.

Otherwise, you can use the venv CLI like so:

python -m venv .venv
# Windows
.venv\Scripts\activate.bat
# Linux
source .venv/bin/activate

2.2 Setting up a Venv Outside the Project Folder

If you're storing the project on a shared directory (EG: a NAS), you shouldn't (and likely won't be able) to create a virtual environment in the project folder itself, since virtual environments aren't portable and therefore shouldn't be set up in shared directories. The way around this is to set up a virtual environment in your home directory and point VSCode to it.

To create the venv in a home directory, run the following commands:

mkdir ~/venvs
python -m venv ~/venvs/screen_brightness_control

Next, in VSCode, open the settings menu select the "User" tab. Search for venvPath and set this value to your new venvs folder (eg: ~/venvs). Finally, open the command palette and search Python: Select Interpreter and select the one from your venv directory.

Install Dependencies

pip install .[dev]   # for local development
pip install .[dist]  # for packaging and distribution
pip install .[docs]  # for generating documentation
pip install .[all]   # install all optional dependencies

Testing

Tests are written with pytest and can be run with the following command:

pytest

Documentation

See docs/README.md for details

Contributors

Thanks to these people for contributing to this project