Skip to main content

Simple API to access Netatmo weather station data from any Python 3 script. Designed for Home Assistant (but not only)

Project description

pyatmo

Code style: black GitHub Actions PyPi license

Warning: Due to personal reasons, I am currently unable to dedicate sufficient time to effectively manage this repository. Consequently, no attention will be given to existing or forthcoming issues until further notice. However, I want to assure you that I will continue to merge any pull requests that are submitted, provided they successfully pass the continuous integration tests and do not exhibit any glaring issues.

I apologize for any inconvenience this may cause, and I sincerely hope to have the capacity to allocate more time to this repository in the near future. Your understanding is greatly appreciated.


Simple API to access Netatmo devices and data like weather station or camera data from Python 3. For more detailed information see dev.netatmo.com

This project has no relation with the Netatmo company.

Install

To install pyatmo simply run:

pip install pyatmo

Depending on your permissions you might be required to use sudo. Once installed you can simply add pyatmo to your Python 3 scripts by including:

import pyatmo

Note

The module requires a valid user account and a registered application. Be aware that the module may stop working if Netatmo decides to change their API.

Development

Clone the repo and install dependencies:

git clone
cd pyatmo
pipenv install --dev

To add the pre-commit hook to your environment run:

pip install pre-commit
pre-commit install

Testing

To run the full suite simply run the following command from within the virtual environment:

pytest

or

python -m pytest tests/

To generate code coverage xml (e.g. for use in VSCode) run

python -m pytest --cov-report xml:cov.xml --cov pyatmo --cov-append tests/

Another way to run the tests is by using tox. This runs the tests against the installed package and multiple versions of python.

tox

or by specifying a python version

tox -e py310

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyatmo-8.1.0.tar.gz (86.6 kB view details)

Uploaded Source

Built Distribution

pyatmo-8.1.0-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file pyatmo-8.1.0.tar.gz.

File metadata

  • Download URL: pyatmo-8.1.0.tar.gz
  • Upload date:
  • Size: 86.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pyatmo-8.1.0.tar.gz
Algorithm Hash digest
SHA256 721f84b950286c8c52082d85a80df14f8095a36156676587f76ca7613ffd2b1f
MD5 48b2692ac446c0e40dcc18dc40729e56
BLAKE2b-256 3b470c2e418d90a8e6313313149cda3c81ad52b77cda4f5f5b77e1211a1f798f

See more details on using hashes here.

File details

Details for the file pyatmo-8.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyatmo-8.1.0-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pyatmo-8.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b837aa48f4ea74e572ef4b23828d43660f0b5ef4402f2c2890eda4b78b9481a1
MD5 c280aca8ff027267ca40e98df4c3034d
BLAKE2b-256 ecf78add34de5b6548ffcf196c1bc810a88b13adfcb2ef580a42f0759d6f1f6a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page