Skip to main content

Kanbanize-sdk is a python library for interacting with the official Kanbanize tool environment in version 2.

Project description

Welcome to Kanbanize SDK

Documentation Status CI codecov PyPI version

Kanbanize-sdk is a python library built on top of the Kanbanize platform API V2. In addition to providing interaction with the platform's resources, we make objects available through dataclasses that they facilitate the composition of parameters used in research and payloads for updating and inserting data into the platform.

Installation

To install the library in your project, you can do it through the pip package manager

pip install kanbanize-sdk

How to use?

Once installed, you can import the class responsible for creating the resource instance, passing the authentication data, and other dataclasses that helped you set up queries and interactions with the desired resources. For example:

from kanbanize_sdk import Kanbanize, UserListParams

if __name__ == '__main__':
	service = Kanbanize({'subdomain': <subdomain_string>, 'api_key': <apikey_string>})
	params = UserListParams(is_enabled=0, users_id=[1,5,20])
	response = service.users().list(params=params)

Every output response will follow the examples listed on the Kanbanize platform, except for making a small adjustment to the response the application will give you. Example from:

{
    "data": [
        {
            "user_id": 0,
            "email": "string",
            "username": "string",
            "realname": "string",
            "avatar": "string",
            "is_enabled": 0,
            "is_confirmed": 0,
            "is_tfa_enabled": 0,
            "registration_date": "2023-10-30"
        }
    ]
}

To:

[
    {
        "user_id": 0,
        "email": "string",
        "username": "string",
        "realname": "string",
        "avatar": "string",
        "is_enabled": 0,
        "is_confirmed": 0,
        "is_tfa_enabled": 0,
        "registration_date": "2023-10-30"
    }
]

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

kanbanize_sdk-0.2.12.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

kanbanize_sdk-0.2.12-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file kanbanize_sdk-0.2.12.tar.gz.

File metadata

  • Download URL: kanbanize_sdk-0.2.12.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.4 Linux/6.5.0-35-generic

File hashes

Hashes for kanbanize_sdk-0.2.12.tar.gz
Algorithm Hash digest
SHA256 88d46d65ba7050628cbd5d0871ebbb231443503782079762593bb20623472323
MD5 0e101cdd6545e428dc34c0a81215ca98
BLAKE2b-256 03ddd4bbda7dd95f001460a7a30ac1d493554ebd1a4c61ac7a7278dd7d295ff8

See more details on using hashes here.

File details

Details for the file kanbanize_sdk-0.2.12-py3-none-any.whl.

File metadata

  • Download URL: kanbanize_sdk-0.2.12-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.4 Linux/6.5.0-35-generic

File hashes

Hashes for kanbanize_sdk-0.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 fffc8e7ab73761eac6fe895e2b19d3e4ef466114920bf565e6662381d9313e34
MD5 93534af3963fe5f1d81019d765142a40
BLAKE2b-256 b57596f36ec10e46e9b78af8a6c6cb637e23692f5103a7c065a880af67eb5ba6

See more details on using hashes here.

Supported by

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