Skip to main content

KE-chain Python SDK

Project description

Version Supported Python Versions Build Status Documentation Status Coverage Status Updates Code Quality from Codacy

About pykechain

pykechain is a python library for advanced users of KE-chain. It will enable users to connect and fully interact to all features of KE-chain, the digital verification and high tech systems design platform of KE-works. With it you can interact with KE-chain, its parts, projects, forms, workflows, activities, scripts and all other aspects of KE-chain from within python scripts or iPython / Jupyter notebooks.

It requires a normal user access to a KE-chain (version 3) instance for it to work.

Basic usage

Ensure you have member access to a KE-chain instance and login:

from pykechain import Client
kec = Client(url='https://<domain>.ke-chain.com')
kec.login(username='demo_user', password='pastaplease')

Now interact with it:

project = kec.scope('Bike Project')
for part in project.parts():
    print(part.name)

Installation

pykechain is easily installed using pip. pykechain is Python 3.7, 3.8, 3.9, 3.10 and pypy3 compatible:

pip install pykechain

Or if you want to live on the edge, install the latest and greatest from the master branch:

pip install https://github.com/KE-works/pykechain/archive/main.zip

In scripts you can either use Pipenv or a pip requirements.txt file to install pykechain as a requirement

in a Pipfile:

[packages]
pykechain = "*"
# or when you want to install a certain branch
pykechain = {ref = "main", git = "https://github.com/KE-works/pykechain"}

in a pip requirements.txt:

pykechain
# or when you want to install a certain branch i.e. `main`
git+https://github.com/KE-works/pykechain.git@main#egg=pykechain

Changelog

A proper changelog is maintained in the Changelog

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pykechain-4.2.2.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

pykechain-4.2.2-py2.py3-none-any.whl (210.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pykechain-4.2.2.tar.gz.

File metadata

  • Download URL: pykechain-4.2.2.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for pykechain-4.2.2.tar.gz
Algorithm Hash digest
SHA256 1cb6d1aae243ebcb465d8fee8db35ed08e760b038d6d15b49de2a4e343853548
MD5 1ba13490af4eb0cf9d6e4d08ba291a68
BLAKE2b-256 784690ec70592b3993454306b85c686177698d68c1ffb028082965014f0f979f

See more details on using hashes here.

File details

Details for the file pykechain-4.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pykechain-4.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 210.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for pykechain-4.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 62a719963f75e4a3428684d96d7ae16721329da6e170b1ddd233881d44b24139
MD5 40ff852ea626b65cbf3cf678c776b077
BLAKE2b-256 974703a00cf5a3ac9e594d9169475a1138727cc55231e17cfa5e9508e8406af1

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