Skip to main content

REST-like HTTP API for LysKOM

Project description

httpkom is an HTTP proxy for LysKOM protocol A servers, and exposes an REST-like HTTP API. It can for example be used for writing LysKOM clients in Javascript.

The source code can be found at: https://github.com/osks/httpkom

Packages are published on PyPI: https://pypi.org/project/httpkom/

The documentation can be found at: http://osks.github.io/httpkom/

httpkom uses pylyskom, which is also released under GPL.

Dependencies

For required Python packages, see requirements.txt. Install them with:

$ pip install -r requirements.txt

Development

Preparing a release

TODO: How do we update the documentation on github pages?

On master:

  1. Update and check CHANGELOG.md.

  2. Increment version number and remove +dev suffix IN BOTH setup.py AND httpkom/version.py!

  3. Test manually by using jskom.

  4. Commit, push.

  5. Tag (annotated) with v<version> (example: v0.1) and push the tag:

    git tag -a v0.1 -m "Version 0.1"
    git push origin v0.1
    
  6. Build PyPI dist: make dist

  7. Push to Test PyPI: twine upload --repository testpypi dist/* and check https://test.pypi.org/project/httpkom/ .

  8. Push to PyPI: twine upload dist/* and check https://pypi.org/project/httpkom/ .

  9. Add +dev suffix to version number, commit and push.

Tools

Install and update release tools with:

pip install --upgrade setuptools wheel pip twine

Twine is used for pushing the built dist to PyPI. The examples in the release process depends on a .pypirc file with config for the pypi and testpypi repositories.

Example of .pypirc:

[pypi]
username = __token__
password = pypi-...

[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = pypi-...

Authors

Oskar Skoog <oskar@osd.se>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for httpkom, version 0.14
Filename, size File type Python version Upload date Hashes
Filename, size httpkom-0.14.tar.gz (19.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page