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.

Hugo DUPRAS (jabesq)


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

Prerequisits:

uv
python >=3.11

Clone the repo, install dependencies and install pre-commit hooks:

git clone
cd pyatmo
uv sync
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-9.2.3.tar.gz (171.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyatmo-9.2.3-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyatmo-9.2.3.tar.gz
  • Upload date:
  • Size: 171.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pyatmo-9.2.3.tar.gz
Algorithm Hash digest
SHA256 b577e94758def04a19f8bdb8b714374f20358d730469f83de1c0cd2ac97b7569
MD5 521a9a622657e4d199447ad4963207c8
BLAKE2b-256 b3ec83908201628973f13e14bdb308a494cdae4ca9c5e884bc9f3ce0c814a999

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyatmo-9.2.3-py3-none-any.whl
  • Upload date:
  • Size: 39.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pyatmo-9.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 eef62f97e057729022ac02d5f22c519b84bfdce0e88d3d8891ba533d3aa988e6
MD5 745b416303847f78507d73a76f6b105a
BLAKE2b-256 5f4389bbc33e89a138b20b132773dca4724045c5f2061347fd12c74ebc65ae6d

See more details on using hashes here.

Supported by

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