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.0.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

pykechain-4.2.0-py2.py3-none-any.whl (209.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for pykechain-4.2.0.tar.gz
Algorithm Hash digest
SHA256 96771f9a6a6b7657143f8e711a903ebee13037cffafaa37b77a2916f9acc669a
MD5 412f58084b0ec59eb4d2f20be6d80555
BLAKE2b-256 4dc9b2f4602bd83786b322b9e156d8d891a091f2a592057474424123f15fa6a3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pykechain-4.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b7467bd98db2ea2a91b4a5a2dc33d35aba16270d5d1b131954a65308ca403718
MD5 7b3435c34f38e6ccd49386475ed790d0
BLAKE2b-256 07e1a82c8d5a9bfc312c0454ada083096a25ee1d9b3e0307f74c2a6db42b29c7

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