Skip to content
A friendly fork of hpfeeds to add python 3 support
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Document running a TLS enabled broker Jun 2, 2018
examples Remove tabs Dec 19, 2017
hpfeeds
.gitignore
.readthedocs.yml
.travis.yml
Dockerfile
LICENSE
MANIFEST.in Add MANIFEST.in May 22, 2018
README.md
codecov.yml
conftest.py Fix tests on py2 Aug 13, 2018
dev.txt
requirements.txt Test bump Nov 23, 2018
setup.cfg
setup.py

README.md

hpfeeds3

PyPI Codecov Read the Docs

About

hpfeeds is a lightweight authenticated publish-subscribe protocol. It has a simple wire-format so that everyone is able to subscribe to the feeds with their favorite language in almost no time. Different feeds are separated by channels and support arbitrary binary payloads. This means that the channel users decide the structure of data. It is common to pass JSON over hpfeeds.

This project aims to deliver a modern python 3 compatible broker written on top of asyncio as well as a python 3 compatible client.

Installation

To use the client you need to install it in your python environment with pip.

pip install hpfeeds3

The core client does not have any dependencies. You can install the broker dependencies with pip too:

pip install hpfeeds3[broker]

You can also run a broker with Docker:

docker run -p "0.0.0.0:20000:20000" -p "0.0.0.0:9431:9431" jc2k/hpfeeds3-broker:latest

It will store access keys in an sqlite database in /app/var. The sqlite client installed in the container for managing access. You should make sure /app/var is a volume. Your clients can connect to port 20000, and prometheus can connect on port 9431.

You can’t perform that action at this time.