Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JurajNyiri authored Nov 27, 2020
1 parent 55351c2 commit 89503fd
Showing 1 changed file with 29 additions and 16 deletions.
45 changes: 29 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,31 @@ Python library for communication with Tapo Cameras
python3 -m pip install pytapo
```

## Test changes:
## Usage examples:

### Initiate library:

```
from pytapo import Tapo
user = "" # user you set in Advanced Settings -> Camera Account
password = "" # password you set in Advanced Settings -> Camera Account
host = "" # ip of the camera, example: 192.168.1.52
tapo = Tapo(host, user, password)
print(tapo.getBasicInfo())
```


## Contributions:

Contributions to pytapo are welcomed. Please make sure to obey any TOS you have agreed to when you bought your Tapo product.
Owner of this repository is not responsible for any PRs or code changes to this project created by 3rd parties.

When you make a new change to the code base, make sure to have 100% unit test coverage.

### Test instructions

Set the following environment variables:

Expand All @@ -24,23 +48,12 @@ Run `pre-commit install` and `pre-commit install -t pre-push`.

Then run `tox` to run all the tests.

Tests and linters are ran automatically before files are commited / pushed.

## Usage examples:
Linters are ran on every commit.

### Initiate library:

```
from pytapo import Tapo
Tests are ran on push.

user = "" # user you set in Advanced Settings -> Camera Account
password = "" # password you set in Advanced Settings -> Camera Account
host = "" # ip of the camera, example: 192.168.1.52
tapo = Tapo(host, user, password)
print(tapo.getBasicInfo())
```
Your camera may do all the actions supported by this library, including, but not limited to, move, change privacy mode and reboot while tests are running.
After the tests are done, your camera should be in the initial state.

## Thank you

Expand Down

0 comments on commit 89503fd

Please sign in to comment.