KE-chain Python SDK
===================
.. image:: https://img.shields.io/pypi/v/pykechain.svg
:target: https://pypi.python.org/pypi/pykechain
:alt: Version
.. image:: https://img.shields.io/pypi/pyversions/pykechain.svg
:target: https://pypi.python.org/pypi/pykechain
:alt: Supported Python Versions
.. image:: https://github.com/KE-works/pykechain/workflows/Test%20pykechain/badge.svg?branch=main
:target: https://github.com/KE-works/pykechain/actions?query=workflow%3A%22Test+pykechain%22+branch%3Amaster
:alt: Build Status
.. image:: https://readthedocs.org/projects/pykechain/badge/?version=stable
:target: https://pykechain.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
.. image:: https://coveralls.io/repos/github/KE-works/pykechain/badge.svg?branch=main
:target: https://coveralls.io/github/KE-works/pykechain?branch=master
:alt: Coverage Status
.. image:: https://pyup.io/repos/github/KE-works/pykechain/shield.svg
:target: https://pyup.io/repos/github/KE-works/pykechain/
:alt: Updates
.. image:: https://app.codacy.com/project/badge/Grade/9584610f1d4d474798c89fe87137c157
:target: https://www.codacy.com/gh/KE-works/pykechain/dashboard
:alt: 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 <http://www.ke-chain.com>`__, the digital verification and high tech systems design
platform of `KE-works <http://www.ke-works.com>`__.
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 <http://jupyter.org>`__ notebooks.
It requires a normal user access to a KE-chain (version 3) instance for it to work.
.. note::
This version of pykechain (> 4.0.0) is compatible with the latest release of KE-chain where we
added the Forms feature. It is fully backward compatible with all KE-chain versions v2022 and higher.
This version discontinues support for python version 3.6.
.. note::
This version of pykechain (> 3.0.0) is suited from KE-chain versions > 3 (or > v2021) running
on ``python >= 3.7`` exclusively. If you desire to connect to an older version of KE-chain or
run on ``python 2.7``, please use a ``pykechain v2`` release. Put in the requirements ``pykechain~=2.7``.
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 <https://github.com/pypa/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 <http://pykechain.readthedocs.io/en/latest/changelog.html>`__
Raw data
{
"_id": null,
"home_page": "https://github.com/KE-works/pykechain",
"name": "pykechain",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "python api rest sdk KE-chain",
"author": "KE-works BV",
"author_email": "support+pykechain@ke-works.com",
"download_url": "https://files.pythonhosted.org/packages/e8/8b/471dd4202520f6b49f0c144861c80c261896d845e9b44ad1e9866eb788d3/pykechain-4.16.0.tar.gz",
"platform": null,
"description": "KE-chain Python SDK\n===================\n\n.. image:: https://img.shields.io/pypi/v/pykechain.svg\n :target: https://pypi.python.org/pypi/pykechain\n :alt: Version\n\n.. image:: https://img.shields.io/pypi/pyversions/pykechain.svg\n :target: https://pypi.python.org/pypi/pykechain\n :alt: Supported Python Versions\n\n.. image:: https://github.com/KE-works/pykechain/workflows/Test%20pykechain/badge.svg?branch=main\n :target: https://github.com/KE-works/pykechain/actions?query=workflow%3A%22Test+pykechain%22+branch%3Amaster\n :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/pykechain/badge/?version=stable\n :target: https://pykechain.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. image:: https://coveralls.io/repos/github/KE-works/pykechain/badge.svg?branch=main\n :target: https://coveralls.io/github/KE-works/pykechain?branch=master\n :alt: Coverage Status\n\n.. image:: https://pyup.io/repos/github/KE-works/pykechain/shield.svg\n :target: https://pyup.io/repos/github/KE-works/pykechain/\n :alt: Updates\n\n.. image:: https://app.codacy.com/project/badge/Grade/9584610f1d4d474798c89fe87137c157\n :target: https://www.codacy.com/gh/KE-works/pykechain/dashboard\n :alt: Code Quality from Codacy\n\n\nAbout pykechain\n---------------\n\n``pykechain`` is a python library for advanced users of KE-chain. It will enable users to connect and fully interact\nto all features of `KE-chain <http://www.ke-chain.com>`__, the digital verification and high tech systems design\nplatform of `KE-works <http://www.ke-works.com>`__.\nWith it you can interact with KE-chain, its parts, projects, forms, workflows, activities, scripts and all other\naspects of KE-chain from within python scripts or iPython / `Jupyter <http://jupyter.org>`__ notebooks.\n\nIt requires a normal user access to a KE-chain (version 3) instance for it to work.\n\n.. note::\n This version of pykechain (> 4.0.0) is compatible with the latest release of KE-chain where we\n added the Forms feature. It is fully backward compatible with all KE-chain versions v2022 and higher.\n This version discontinues support for python version 3.6.\n\n.. note::\n This version of pykechain (> 3.0.0) is suited from KE-chain versions > 3 (or > v2021) running\n on ``python >= 3.7`` exclusively. If you desire to connect to an older version of KE-chain or\n run on ``python 2.7``, please use a ``pykechain v2`` release. Put in the requirements ``pykechain~=2.7``.\n\nBasic usage\n-----------\n\nEnsure you have member access to a KE-chain instance and login::\n\n from pykechain import Client\n kec = Client(url='https://<domain>.ke-chain.com')\n kec.login(username='demo_user', password='pastaplease')\n\nNow interact with it::\n\n project = kec.scope('Bike Project')\n for part in project.parts():\n print(part.name)\n\nInstallation\n------------\n\npykechain is easily installed using pip. ``pykechain`` is Python ``3.7``, ``3.8``, ``3.9``, ``3.10``\nand ``pypy3`` compatible::\n\n pip install pykechain\n\nOr if you want to live on the edge, install the latest and greatest from the master branch::\n\n pip install https://github.com/KE-works/pykechain/archive/main.zip\n\nIn scripts you can either use `Pipenv <https://github.com/pypa/pipenv>`__ or a pip ``requirements.txt`` file to\ninstall ``pykechain`` as a requirement\n\nin a ``Pipfile``::\n\n [packages]\n pykechain = \"*\"\n # or when you want to install a certain branch\n pykechain = {ref = \"main\", git = \"https://github.com/KE-works/pykechain\"}\n\nin a pip ``requirements.txt``::\n\n pykechain\n # or when you want to install a certain branch i.e. `main`\n git+https://github.com/KE-works/pykechain.git@main#egg=pykechain\n\nChangelog\n---------\n\nA proper changelog is maintained in the `Changelog <http://pykechain.readthedocs.io/en/latest/changelog.html>`__\n",
"bugtrack_url": null,
"license": "Apache Open Source License 2.0",
"summary": "KE-chain Python SDK",
"version": "4.16.0",
"project_urls": {
"Changelog": "https://github.com/KE-works/pykechain/blob/master/CHANGELOG.rst",
"Company Page": "https://ke-chain.com",
"Documentation": "https://pykechain.readthedocs.io/en/latest",
"Homepage": "https://github.com/KE-works/pykechain",
"Source": "https://github.com/KE-works/pykechain/",
"Tracker": "https://github.com/KE-works/pykechain/issues"
},
"split_keywords": [
"python",
"api",
"rest",
"sdk",
"ke-chain"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "807aa954fffa46e6058ac1b0edd482f4069f93a48022e8fdc0804a0dc3a99a06",
"md5": "423e33522761f39f2f8a5f4aed4820cf",
"sha256": "ffe964cc9d72b7de22d534345e94b043658651532aac9b86b1e390a10600735f"
},
"downloads": -1,
"filename": "pykechain-4.16.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "423e33522761f39f2f8a5f4aed4820cf",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 219818,
"upload_time": "2025-01-23T14:32:18",
"upload_time_iso_8601": "2025-01-23T14:32:18.723315Z",
"url": "https://files.pythonhosted.org/packages/80/7a/a954fffa46e6058ac1b0edd482f4069f93a48022e8fdc0804a0dc3a99a06/pykechain-4.16.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e88b471dd4202520f6b49f0c144861c80c261896d845e9b44ad1e9866eb788d3",
"md5": "a8a21edd8b7007d7e2fb6dafdbbfc4ad",
"sha256": "235acc15dfc29107d9f8e5cf9cf284fbc896a379b3cb2c870a91f5a67be3971e"
},
"downloads": -1,
"filename": "pykechain-4.16.0.tar.gz",
"has_sig": false,
"md5_digest": "a8a21edd8b7007d7e2fb6dafdbbfc4ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5944378,
"upload_time": "2025-01-23T14:32:22",
"upload_time_iso_8601": "2025-01-23T14:32:22.511489Z",
"url": "https://files.pythonhosted.org/packages/e8/8b/471dd4202520f6b49f0c144861c80c261896d845e9b44ad1e9866eb788d3/pykechain-4.16.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 14:32:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KE-works",
"github_project": "pykechain",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "envparse",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "jsonschema",
"specs": [
[
"==",
"4.23.0"
]
]
},
{
"name": "semver",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.3.4"
]
]
},
{
"name": "pytest-xdist",
"specs": [
[
"==",
"3.6.1"
]
]
},
{
"name": "betamax",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "coverage",
"specs": [
[
"~=",
"7.6.10"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
"==",
"6.0.0"
]
]
},
{
"name": "coveralls",
"specs": [
[
"==",
"4.0.1"
]
]
},
{
"name": "Pillow",
"specs": [
[
"==",
"11.1.0"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"7.2.6"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"~=",
"7.1.2"
]
]
},
{
"name": "nbsphinx",
"specs": [
[
"==",
"0.9.6"
]
]
},
{
"name": "tox",
"specs": [
[
"==",
"4.23.2"
]
]
},
{
"name": "flake8",
"specs": [
[
"==",
"7.1.1"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"8.5.0"
]
]
},
{
"name": "pydocstyle",
"specs": [
[
"==",
"6.3.0"
]
]
},
{
"name": "mypy",
"specs": [
[
"==",
"1.14.1"
]
]
},
{
"name": "pre-commit",
"specs": [
[
"==",
"4.0.1"
]
]
},
{
"name": "twine",
"specs": [
[
"~=",
"6.0"
]
]
},
{
"name": "twine",
"specs": [
[
"~=",
"3.0"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.2"
]
]
}
],
"tox": true,
"lcname": "pykechain"
}
JSON
