Skip to main content

provides endpoints and messages for gRPC communication with the ONDEWO SIP server

Project description

Logo

ONDEWO-SIP Client Library

This library facilitates the interaction between a user and an ONDEWO-SIP server instance.

It is structured around a series of python files generated from protobuf files. These protobuf files specify the details of the interface, and can be used to generate code in 10+ high-level languages. They are found in the submodule ondewo-sip-api of this git repo.

The documentation of the ondewo-sip API is available here

Python Installation

git clone git@github.com:ondewo/ondewo-sip-client-python.git
cd ondewo-sip-client-python
pip install -e .

Let's Get Started! (WIP)

Import your programming interface:

ls ondewo

Get a suitable example:

ls examples

Automatic Release Process

The entire process is automated to make development easier. The actual steps are simple:

TODOs in Pull Request before the release:

  • Update the Version number inside the Makefile

    • ! : Major and Minor Version Number must be the same for Client and API at all times

      example: API 2.9.0 --> Client 2.9.X

  • Check if RELEASE.md is up-to-date

  • Update the Version number inside the setup.py by using:

    make update_setup
    

TODOs after Pull Request was merged in:

  • Checkout master:
    git checkout master
    
  • Pull the new stuff:
    git pull
    
  • Release:
    make ondewo_release
    

The make ondewo_release command can be divided into 5 steps:

  • cloning the devops-accounts repository and extracting the credentials
  • creating and pushing the release branch
  • creating and pushing the release tag
  • creating the GitHub release
  • creating and pushing the new PyPi release

The variables for the GitHub Access Token, PyPi Username and Password are all inside of the Makefile, but the values are overwritten during make ondewo_release, because they are passed from the devops-accounts repo as arguments to the actual release command.

Project details


Download files

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

Source Distribution

ondewo-sip-client-3.7.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ondewo_sip_client-3.7.0-py2.py3-none-any.whl (14.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ondewo-sip-client-3.7.0.tar.gz.

File metadata

  • Download URL: ondewo-sip-client-3.7.0.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for ondewo-sip-client-3.7.0.tar.gz
Algorithm Hash digest
SHA256 5adb60ed396ed6bf7b96ca7b8c43513039923ca569ad8c1064cbdbd8c8989bd9
MD5 1645f2424df8348bbc9a5d9f48397b84
BLAKE2b-256 a94f9b7f58b5cfeabd68f3dbf4941d94ed270aafafd2e60aa944bde60f3df924

See more details on using hashes here.

File details

Details for the file ondewo_sip_client-3.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ondewo_sip_client-3.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 83bad34739e201ed16d6b7f70ffd70072e988045e195157e9f0421230d1b2a5e
MD5 582a1b2567af742193f9a31384aa1073
BLAKE2b-256 f34086f808285124fafaa4348b9615ae0e4cd0e52ff3851c16faea17025c5cee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page