pykechain


Namepykechain JSON
Version 1.4.1 PyPI version JSON
home_pagehttps://github.com/KE-works/pykechain
SummaryKE-chain Python SDK
upload_time2017-02-17 18:26:12
maintainer
docs_urlNone
authorKE-works BV
requires_python
licenseApache Open Source License 2.0
keywords python api rest sdk ke-chain
VCS
bugtrack_url
requirements requests envparse pytest betamax Sphinx nbsphinx jupyter matplotlib tox
Travis-CI
Coveralis test coverage No Coveralis.
            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://travis-ci.org/KE-works/pykechain.svg?branch=master
    :target: https://travis-ci.org/KE-works/pykechain
    :alt: Build Status

.. image:: https://readthedocs.org/projects/pykechain/badge/?version=latest
    :target: http://pykechain.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://coveralls.io/repos/github/KE-works/pykechain/badge.svg?branch=master
    :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


About pykechain
---------------

pykechain is a python library for advanced users and KE-chain configurations to connect and interact fully to all
features of `KE-chain <http://www.ke-chain.com>`__, the engineering platform of `KE-works <http://www.ke-works.com>`__.
With it you can interact with KE-chain, its product information model (PIM), its workflow information model (WIM) and
many other aspects of KE-chain from python scripts or iPython / `Jupyter <http://jupyter.org>`__ notebooks.

It requires normal user access to a KE-chain (version 2) 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://kec2api.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 2.7, 3.5 and 3.6 compatible::

    pip install pykechain

Or install the latest and greatest::

    pip install https://github.com/KE-works/pykechain/archive/master.zip
    # or the dev branch
    pip install https://github.com/KE-works/pykechain/archive/dev.zip



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "coveralis": false, 
    "keywords": "python api rest sdk KE-chain", 
    "tox": true, 
    "requirements": [
        {
            "name": "requests", 
            "specs": [
                [
                    "==", 
                    "2.13.0"
                ]
            ]
        }, 
        {
            "name": "envparse", 
            "specs": [
                [
                    "==", 
                    "0.2.0"
                ]
            ]
        }, 
        {
            "name": "pytest", 
            "specs": [
                [
                    "==", 
                    "3.0.6"
                ]
            ]
        }, 
        {
            "name": "betamax", 
            "specs": [
                [
                    "==", 
                    "0.8.0"
                ]
            ]
        }, 
        {
            "name": "Sphinx", 
            "specs": [
                [
                    "==", 
                    "1.5.2"
                ]
            ]
        }, 
        {
            "name": "nbsphinx", 
            "specs": [
                [
                    "==", 
                    "0.2.13"
                ]
            ]
        }, 
        {
            "name": "jupyter", 
            "specs": [
                [
                    "==", 
                    "1.0.0"
                ]
            ]
        }, 
        {
            "name": "matplotlib", 
            "specs": [
                [
                    "==", 
                    "2.0.0"
                ]
            ]
        }, 
        {
            "name": "tox", 
            "specs": [
                [
                    "==", 
                    "2.6.0"
                ]
            ]
        }
    ], 
    "author": "KE-works BV", 
    "home_page": "https://github.com/KE-works/pykechain", 
    "github_user": "KE-works", 
    "download_url": "", 
    "platform": "", 
    "version": "1.4.1", 
    "cheesecake_documentation_id": 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://travis-ci.org/KE-works/pykechain.svg?branch=master\n    :target: https://travis-ci.org/KE-works/pykechain\n    :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/pykechain/badge/?version=latest\n    :target: http://pykechain.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://coveralls.io/repos/github/KE-works/pykechain/badge.svg?branch=master\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\nAbout pykechain\n---------------\n\npykechain is a python library for advanced users and KE-chain configurations to connect and interact fully to all\nfeatures of `KE-chain <http://www.ke-chain.com>`__, the engineering platform of `KE-works <http://www.ke-works.com>`__.\nWith it you can interact with KE-chain, its product information model (PIM), its workflow information model (WIM) and\nmany other aspects of KE-chain from python scripts or iPython / `Jupyter <http://jupyter.org>`__ notebooks.\n\nIt requires normal user access to a KE-chain (version 2) instance for it to work.\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://kec2api.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 2.7, 3.5 and 3.6 compatible::\n\n    pip install pykechain\n\nOr install the latest and greatest::\n\n    pip install https://github.com/KE-works/pykechain/archive/master.zip\n    # or the dev branch\n    pip install https://github.com/KE-works/pykechain/archive/dev.zip\n\n\n", 
    "upload_time": "2017-02-17 18:26:12", 
    "lcname": "pykechain", 
    "bugtrack_url": null, 
    "github": true, 
    "name": "pykechain", 
    "license": "Apache Open Source License 2.0", 
    "travis_ci": true, 
    "github_project": "pykechain", 
    "summary": "KE-chain Python SDK", 
    "split_keywords": [
        "python", 
        "api", 
        "rest", 
        "sdk", 
        "ke-chain"
    ], 
    "author_email": "support+pykechain@ke-works.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-02-17T18:26:12", 
            "comment_text": "", 
            "python_version": "py2.py3", 
            "url": "https://pypi.python.org/packages/c2/94/2e9e84780a74bdef5b8a8a39ecbe4b16304012009fb662a690e0c448a3db/pykechain-1.4.1-py2.py3-none-any.whl", 
            "md5_digest": "57a256c437af466f2934740dc55b7054", 
            "downloads": 0, 
            "filename": "pykechain-1.4.1-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "c2/94/2e9e84780a74bdef5b8a8a39ecbe4b16304012009fb662a690e0c448a3db/pykechain-1.4.1-py2.py3-none-any.whl", 
            "size": 19335
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}