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

This version

4.3.0

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

Uploaded Source

Built Distribution

pykechain-4.3.0-py2.py3-none-any.whl (210.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for pykechain-4.3.0.tar.gz
Algorithm Hash digest
SHA256 4813780d8efbf9178a7194d838db70f84745c7c4244b1521ececbf1eb19b0792
MD5 179ee6cdfe64d58ee2b686979963bb12
BLAKE2b-256 fd711510c84a0b92aae2067a5d113123af971e93fbe5863c5022d2f51b0a3594

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pykechain-4.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82ab4dd716d72ec82869536938888061a4ce13f89ef7f5d895848a5f5ccc068f
MD5 c2b326c89f4470a120292a3b352c4e41
BLAKE2b-256 e7eb969f477248dd5734a96a1cb9a079d0b9645616b0eb0d55d8c2ed0a010b95

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