Giter Club home page Giter Club logo

heim's Introduction

🏑
Heim

A home monitoring system, focused on temperature and power usage

Project setup

You need Python 3.10+ and PostgreSQL 12+ to run this project.

  1. Start by installing the dependencies:

    poetry install
  2. Next you need to set some environment variables, for this I recommend direnv:

    # Auto-activate venv
    load_prefix <path to project>/.venv
    export VIRTUAL_ENV=<path to project>/.venv
    
    # Set up aqara integration
    export AQARA_APP_ID=...
    export AQARA_APP_KEY=...
    export AQARA_KEY_ID=...
    export AQARA_DOMAIN=open-ger.aqara.com
    
    # Specify which database to use
    export PGDATABASE=heim
  3. Create the database:

    createdb heim
  4. Apply migrations:

    ./bin/migrate
  5. That should be if, you're now good to go.

Running

To run the server use any ASGI server. uvicorn is installed as part of the project dependencies. It supports reloading as well:

uvicorn heim.server:app --reload

In addition to the HTTP component, heim also has a background task runner that has to be run as a separate process:

./bin/run-tasks

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.