Git Product home page Git Product logo

geppetto's Introduction

Build Status Coverage Status Geppetto

Geppetto is a home automation server. It's written for the Raspberry Pi but with some small modification you should be able to run it on other devices with GPIO pins. Geppetto provides a REST API which let you control the GPIO pins of your Raspberry Pi. Apps can be build on top of this API in order to control the GPIO pins easily.

Full documentation is available on RTD.

Installation

Geppetto has been tested under Python 3.3 and Python 3.4. Geppetto uses Quick2Wire's gpio-admin and its Python wrapper. The documentation of this wrapper says that it works with Python 3, but my experience is that it works well with Python 2.7 too.

$ pyvenv-3.4 .env
$ source .env/bin/activate
$ pip install -r requirements.txt

Install GPIO ADMIN by following the installation instructions.

Create a database database and generate an API key:

$ pynt setup_db
[ build.py - Starting task "setup_db" ]
[ build.py - Completed task "setup_db" ]
$ pynt create_user
[ build.py - Starting task "create_user" ]
User <User 1, api_key: b'fcba99ca-3360-4683-a54d-1ce8ad1f20f3'> has been created.
[ build.py - Completed task "create_user" ]

Running

In order to start the webserver in development mode, set environment variable GEPPETTO_ENV to dev.

$ export GEPPETTO_ENV=dev
$ ./server.py

Tests

Tests are written using py.test. Run the test suite with:

$ py.test tests/

Documentation

The documentation is powered by Sphinx and can be build with:

$ sphinx-build -aE -b html docs docs/_build

or with

$ make -C docs html

geppetto's People

Contributors

orangetux avatar

Watchers

 avatar  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.