Skip to main content

SDK helper library

Project description

Build Status Codecov Status Pypi Version Code Climate Requirements Status

Sdklib helps you to write you own client library which will consume a specific service.

Highlights

  • Python 2.7+ or 3.3+.
  • Only http/https protocol is currently supported.
  • BDD integration.

Install

Install the sdklib package using pip:

pip install sdklib

Sample

Find my first SDK on github: https://github.com/ivanprjcts/my-first-sdk

from sdklib.http import HttpSdk

class FirstSdk(HttpSdk):
    """
    My First Sdk.
    """
    DEFAULT_HOST = "http://mockapi.sdklib.org"

    API_ITEMS_URL_PATH = "/items/"

    def create_item(self, name, description=None):
        """
        Create an item.

        :type name: str
        :type description: str
        :return: SdkResponse
        """
        params = parse_args(name=name, description=description)
        return self.post(self.API_ITEMS_URL_PATH, body_params=params)

Run tests

Running testing with coverage:

py.test --cov=sdklib tests/

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to Authors.

Authors

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 sdklib, version 1.10.3
Filename, size File type Python version Upload date Hashes
Filename, size sdklib-1.10.3-py2.7.egg (131.1 kB) File type Egg Python version 2.7 Upload date Hashes View hashes
Filename, size sdklib-1.10.3.tar.gz (38.6 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