Skip to content

Polish readme with uv for local running #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rkm3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Polish readme with uv for local running #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Icon
# Github Actions
.secrets

# uv / venv
.venv/

# pytest
**/__pycache__
.pytest_cache/
Expand Down
21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Pull data from your ThermoWorks Cloud connected thermometers

This is an unofficial library written using the observed behavior of the ThermoWorks Cloud web client (https://cloud.thermoworks.com/home)

The primary purpose of this library is to make ThermoWorks data available for usage in the acompanying [Home Assistant ThermoWorks Cloud Ingegration](https://github.com/a2hill/ha-thermoworks-cloud)
The primary purpose of this library is to make ThermoWorks data available for usage in the acompanying [Home Assistant ThermoWorks Cloud Ingegration](https://github.com/a2hill/ha-thermoworks-cloud)

### Supported Devices
This library has been tested with the following devices:
Expand All @@ -25,15 +25,32 @@ More more information on supported devices see the discussion thread: [ThermoWor


## Installation

To use the library in another project:

```bash
pip install thermoworks-cloud
```

To work on this repo or run the examples, install [uv](https://docs.astral.sh/uv/getting-started/installation/) and sync dependencies:

```bash
uv sync
```

For development (tests, linting, docs):

```bash
uv sync --extra dev
```

## Usage
See [examples/](examples/)

Copy `.secrets.example` to `.secrets` and set `THERMOWORKS_EMAIL` and `THERMOWORKS_PASSWORD` (lines starting with `#` are ignored):

```bash
env $(cat .secrets) python3 examples/get_devices_for_user.py
env $(grep -v '^#' .secrets | xargs) uv run python examples/get_devices_for_user.py
```

## Docs
Expand Down
Loading