Sitelet https://github.com/tv4you2016/pyvesyncV2/commit/3991cc25e3473f1e3ba97f4891c57c65cffe1bca
Skip to content

Commit 3991cc2

Browse files
committed
Adding CONTRIBUTING.md
1 parent e0b6618 commit 3991cc2

2 files changed

Lines changed: 44 additions & 1 deletion

File tree

‎CONTRIBUTING.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Setting up the Development Environment
2+
3+
1. Git clone the repository
4+
5+
```
6+
git clone https://github.com/webdjoe/pyvesync
7+
```
8+
9+
2. Create and activate a separate python virtual environment for pyvesync
10+
11+
```
12+
# Create a new venv
13+
python3 -m venv pyvesync-venv
14+
# Activate the venv
15+
source pyvesync-venv/bin/activate
16+
```
17+
18+
3. Install pyvesync in the venv
19+
20+
```
21+
pip3 install -e pyvesync/
22+
```
23+
24+
If the above steps were executed successfully, you should now have:
25+
26+
- Code directory `pyvesync`(which we cloned from github)
27+
- Python venv directory `pyvesync` (all the dependencies/libraries are contained here)
28+
29+
Any change in the code will now be directly reflected and can be tested. To deactivate the python venv, simply
30+
run `deactivate`.
31+
32+
# Testing Python with Tox
33+
34+
Install tox, navigate to the pyvesync repository which contains the tox.ini file, and run tox as follows:
35+
36+
```
37+
pip install tox
38+
cd pyvesync
39+
tox
40+
```
41+

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,4 +548,6 @@ After:
548548
}
549549
```
550550

551-
All contributions are welcome, please run `tox` before submitting a PR to ensure code is valid.
551+
All [contributions](CONTRIBUTING.md) are welcome, please run `tox` before submitting a PR to ensure code is valid.
552+
553+
This project is licensed under [MIT](LICENSE).

0 commit comments

Comments
 (0)