- Git clone the repository
git clone https://github.com/webdjoe/pyvesync
- Create and activate a separate python virtual environment for pyvesync
# Create a new venv
python3 -m venv pyvesync-venv
# Activate the venv
source pyvesync-venv/bin/activate
- Install pyvesync in the venv
pip3 install -e pyvesync/
If the above steps were executed successfully, you should now have:
- Code directory
pyvesync(which we cloned from github) - Python venv directory
pyvesync(all the dependencies/libraries are contained here)
Any change in the code will now be directly reflected and can be tested. To deactivate the python venv, simply
run deactivate.
Install tox, navigate to the pyvesync repository which contains the tox.ini file, and run tox as follows:
pip install tox
cd pyvesync
tox
If you integrate a new device, please read the testing README to ensure that your device is tested.