Python client for Beaconpush.
Python
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
beaconpush
.gitignore
README.md
requirements.txt
setup.py

README.md

Beaconpush Python Client

A Python client for Beaconpush, a real-time messaging server. This module ships with two clients, one for sending messages to the server and one for event listening. The client follows the same partitioning scheme as the Beaconpush server and has built-in support for connecting to a cluster of servers. It is only compatible with the On-Site edition of Beaconpush.

Installing

The package is available from PyPI, (the Python Package Index aka "The Cheese Shop"). To install the client use either pip (recommended) or easy_install:

pip install beaconpush-client

Releasing a new version

Releasing a new version requires a bit of manual work. Perhaps this can be (more) automated in the future. But for now, the following steps do the job:

  1. Commit your changes and make sure you don't have uncommitted files inside the modules.
  2. Update the version number inside the module (follow semantic versioning).
  3. Make sure the new version number is reflected by running python setup.py --version.
  4. Commit your change of version.
  5. Tag your new commit as a stable version. You can do this by running git tag $(python setup.py --version). Then make sure you push this new tag git push origin $(python setup.py --version).
  6. Run python setup.py clean sdist to create a source distribution.
  7. Upload this to your Python repository (we run an internal PyPI repo at ESN requiring you to upload the sdist yourself)
  8. Set the new development version to be used and commit the change.

Author

License

Open-source licensed under the MIT license (see LICENSE file for details).