Hypergolix demos in python.
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
echo-101
telemeter
.codeclimate.yml
.gitignore
.travis.yml
LICENSE.txt
README.md

README.md

Hypergolix demos

Hypergolix 101: an echo server

Hypergolix 101: an echo server

Start with a newly-flashed Raspberry Pi. End with an echo server that shares objects between the Pi and another computer, dynamically propagating updates between them. Duration: about 10 minutes. Read more here.

Setting up a Hypergolix environment

Connecting an applciation to Hypergolix requires three things:

  1. A "persistence server" (think of this as Amazon S3 + pub/sub + Golix object verification), shared between all communicating parties. This must be passed to Hypergolix when starting the service.
  2. Hypergolix itself: the background service that performs all of the Golix crypto operations, object synchronization, etc. Each party has its own Hypergolix service.
  3. A (websockets over localhost) IPC link to the Hypergolix service. The Hypergolix library includes this, provided you're coding in Python 3.5.1 or newer.

Hypergolix itself will soon ship including (but not requiring) a PaaS persistence server. In the meantime, you'll have to set one up yourself. Generally speaking, this involves running the demo-server.py script from within the demo repository. Be aware that the demo server stores everything in volatile memory. At the moment, the same is true of the Hypergolix service.

Installing and running Hypergolix

Prerequisites

  1. Python 3.5.1+
  2. On Linux and OSX, the ability to compile C extensions (python3-dev)

Installation

From within a temp folder:

git clone https://github.com/Muterra/py_hypergolix .
pip install .

Or, if you'd like to tinker, clone it to a development director and run pip with the "editable" flag:

git clone https://github.com/Muterra/py_hypergolix .
pip install . -e

Note: best practices would have you install it within a virtualenv!

Running Hypergolix

python3 -m hypergolix.service

Or, to run it in the background (Linux only):

python3 -m hypergolix.service &

Available flags:

--host        IP/web address for persistence provider. Default: localhost
--port        The persistence provider port. Default: 7770
--ipc_port    Port to use for websockets IPC. Default: 7772
--logfile     Dumps logging into a the specified file, relative to current dir.
              Default: None
--verbosity   Sets debug mode and specifies the logging level. Valid options:
                  debug       most verbose
                  info        somewhat more verbose
                  warning     the default Python verbosity
                  error       quiet

To stop Hypergolix, send it SIGTERM or SIGINT (if you don't know what those are, press Ctrl+C).

Contributing

Help is welcome and needed. Unfortunately we're so under-staffed that we haven't even had time to make a thorough contribution guide. In the meantime:

Guide

  • Issues are great! Open them for anything: feature requests, bug reports, etc.
  • Fork, then PR.
  • Open an issue for every PR.
    • Use the issue for all discussion.
    • Reference the PR somewhere in the issue discussion.
  • Please be patient. We'll definitely give feedback on anything we bounce back to you, but especially since we lack a contribution guide, style guide, etc, this may be a back-and-forth process.
  • Please be courteous in all discussion.

Project priorities

Note: these needs are specific to external contributors. Internal development priorities differ substantially.

  • Contribution guide
  • Code of conduct
  • Get feedback from other people who have replicated demos
  • Fix code in written echo-101 demo to match the demo video

See also:

Sponsors and backers

If you like what we're doing, please consider sponsoring the project or becoming a backer.

Sponsors


Backers