Code Monkey home page Code Monkey logo

pyatmo's Introduction

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. See usage.md for further information. 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 smart_home --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

pyatmo's People

Contributors

asphotographics avatar carstenschroeder avatar cgtobi avatar chpego avatar colinfrei avatar danielhiversen avatar deosrc avatar dependabot[bot] avatar fxstein avatar gieljnssns avatar giogua avatar gp8x avatar hydrelioxgithub avatar jabesq avatar jocel1 avatar kwull avatar lasote avatar mastnym avatar msvinth avatar natmarchand avatar philippelt avatar piitaya avatar poppypop avatar pre-commit-ci[bot] avatar pyup-bot avatar rmkraus avatar rogerxaic avatar schmittx avatar shanbs avatar wtaferner avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.