{ "info": { "author": "Stefan Elethofer", "author_email": "stefan.eletzhofer@nexiles.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "=================\r\nnexiles.tools.api\r\n=================\r\n\r\n:Author: Stefan Eletzhofer, nexiles GmbH\r\n:Date: 2015-03-25\r\n:Version: 0.4\r\n:License: BSD\r\n\r\nAbstract\r\n========\r\n\r\nThis is the repository of the *python* HTTP API **client** to the *nexiles.tools*\r\nWindchill API of nexiles GmbH.\r\n\r\nFeatures\r\n========\r\n\r\n- Querying\r\n- read and write IBA Attributes\r\n- up- and download of content\r\n- create and delete Business Objects (WTPart, WTDocument, Products)\r\n- usage, used-by, references navigation of parts and epm documents\r\n- type information queries\r\n- team, role, user queries\r\n- no InfoEngine license needed!\r\n\r\nSupported Business Objects\r\n--------------------------\r\n\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| name | business object | actions available |\r\n+===============+===========================================================+==============================================================+\r\n| organizations | wt.inf.Organization | |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| products | wt.pdm.PDMLinkProduct | container attributes parts documents epmdocuments |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| libraries | wt.inf.library.WTLibrary | container attributes parts documents epmdocuments |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| projects | wt.projmgmt.admin.Project2 | container attributes parts documents epmdocuments |\r\n| | | workpackages |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| cabinets | wt.folder.Cabinet | |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| folders | wt.folder.SubFolder | |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| epmdocuments | wt.epm.EPMDocument | container attributes history content uses references used_by |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| parts | wt.part.WTPart | container attributes history content uses |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| documents | wt.doc.WTDocument | container attributes history content |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| teams | wt.inf.team.ContainerTeam | roles participants |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| groups | wt.org.WTGroup | members |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| users | wt.org.WTUser | |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| types | com.ptc.core.meta.type.mgmt.server.impl.WTTypeDefinition | attribute_names |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| reports | wt.query.template.ReportTemplate | execute |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n| workpackages | com.ptc.windchill.wp.WorkPackage | content container attributes |\r\n+---------------+-----------------------------------------------------------+--------------------------------------------------------------+\r\n\r\n\r\nUsage Example\r\n=============\r\n\r\nFor e.g. fetching all `WTDocuments` which match a certain number::\r\n\r\n >>> from nexiles.tools.api import get_api\r\n >>> api = get_api(\"http://www.example.com/Windchill\", username=\"fred\", password=\"kaputnik\")\r\n >>> docs = api.documents(number=\"1003*\")\r\n\r\nFetching a certain document identified by it's `OID`::\r\n\r\n >>> doc = api.document(\"OR:wt.doc.WTDocument:2342344\")\r\n >>> doc.name, doc.number, doc.version\r\n u'Test Document', u'12345345', u'A.3'\r\n\r\nFetching the `PRIMARY CONTENT` of a `part`::\r\n\r\n >>> content = api.parts(\"OR:wt.epm.EPMDocument:4711\").content.get(role=\"PRIMARY\", filename=\"COVER.PRT\")\r\n\r\nFor more examples, see the documentation.\r\n\r\nRequirements\r\n============\r\n\r\nServer Side Requirements\r\n------------------------\r\n\r\nTo use the API, you need a recent version of the **nexiles.tools**\r\ninstalled on your Windchill server.\r\n\r\nWe currently support Windchill 9.1, 10.x.\r\n\r\nPlease contact info@nexiles.com for licensing and deployment information\r\nregarding the server-side package.\r\n\r\n\r\nClient Side Requirements\r\n------------------------\r\n\r\nTo use the API on your clients, you need:\r\n\r\n- a recent python (testing is done with 2.7.x, we're not python 3\r\n compatible yet)\r\n\r\n- The dependencies listed in the `setup.py` file. Note that\r\n these should be installed automatically.\r\n\r\nDocumentation\r\n=============\r\n\r\nSee https://skynet.nexiles.com/docs/nexiles.tools.api/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://nexiles.github.io/nexiles.tools.api/", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "nexiles.tools.api", "package_url": "https://pypi.org/project/nexiles.tools.api/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/nexiles.tools.api/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://nexiles.github.io/nexiles.tools.api/" }, "release_url": "https://pypi.org/project/nexiles.tools.api/0.4/", "requires_dist": null, "requires_python": null, "summary": "nexiles.tools.api -- python nexiles Windchill gateway http client api", "version": "0.4" }, "last_serial": 1634471, "releases": { "0.3": [ { "comment_text": "", "digests": { "md5": "094afeba6d3d86fd703572b87a10e9ce", "sha256": "8960c834595880283198cf2eece2b0d45155bc010cf373a04c399b4cff3ae7fd" }, "downloads": -1, "filename": "nexiles.tools.api-0.3-py2.7.egg", "has_sig": false, "md5_digest": "094afeba6d3d86fd703572b87a10e9ce", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 747060, "upload_time": "2015-06-08T12:40:29", "url": "https://files.pythonhosted.org/packages/db/95/c39fb1c20b53ab5b9a6c04e6eccfcba85cb8266b9a3a83aea8c61ae627dd/nexiles.tools.api-0.3-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "0d7ef791137a5253469459eba8577218", "sha256": "03287cdd185fd91642cb76aa4d0c7ce9819522be66a29aa639fc76ea68a2d0a0" }, "downloads": -1, "filename": "nexiles.tools.api-0.3.tar.gz", "has_sig": false, "md5_digest": "0d7ef791137a5253469459eba8577218", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26309, "upload_time": "2015-06-08T12:44:26", "url": "https://files.pythonhosted.org/packages/b7/00/01fd1bd2cbbcc81cc8d18640c8269a8f09f1368ee69ca659ef81a262cdeb/nexiles.tools.api-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "7b4fe75d1271adcd71cbdd50857d0f54", "sha256": "8d59cf660c47e7cc58cac8d30b7e531d2f19371e6f9eb19205c764719e7c2b6a" }, "downloads": -1, "filename": "nexiles.tools.api-0.4.tar.gz", "has_sig": false, "md5_digest": "7b4fe75d1271adcd71cbdd50857d0f54", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26741, "upload_time": "2015-07-03T08:39:27", "url": "https://files.pythonhosted.org/packages/b3/7e/4443a8d2aaf29ecd30e4f50004ef6d9baba807ee0daec248bc04c982a96d/nexiles.tools.api-0.4.tar.gz" } ], "0.5.dev0": [ { "comment_text": "", "digests": { "md5": "5d9337cecaf2025026de6e6e8c000b72", "sha256": "25c8b0ac3f9071f99baa15ed4c11e1e807c32970f4b0bed43e7ffb8487ea2e0b" }, "downloads": -1, "filename": "nexiles.tools.api-0.5.dev0-py2-none-any.whl", "has_sig": false, "md5_digest": "5d9337cecaf2025026de6e6e8c000b72", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 701725, "upload_time": "2015-07-15T14:21:03", "url": "https://files.pythonhosted.org/packages/a8/31/3617fd65af81d6eca6de4bd414f1f40f6c924cef90416158c20517148520/nexiles.tools.api-0.5.dev0-py2-none-any.whl" } ], "0.5dev": [ { "comment_text": "", "digests": { "md5": "6c30e5c4316d6c443ca2deb43fd8a7c3", "sha256": "01a539bf6032466116a16723f37d29ee884dace589a9bb710e9d04f0e8b027ec" }, "downloads": -1, "filename": "nexiles.tools.api-0.5dev-py2.7.egg", "has_sig": false, "md5_digest": "6c30e5c4316d6c443ca2deb43fd8a7c3", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 747871, "upload_time": "2015-07-15T14:19:02", "url": "https://files.pythonhosted.org/packages/ae/5a/85cea991643c9993518ada8db5531a138026582c668190bc429cc232783e/nexiles.tools.api-0.5dev-py2.7.egg" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7b4fe75d1271adcd71cbdd50857d0f54", "sha256": "8d59cf660c47e7cc58cac8d30b7e531d2f19371e6f9eb19205c764719e7c2b6a" }, "downloads": -1, "filename": "nexiles.tools.api-0.4.tar.gz", "has_sig": false, "md5_digest": "7b4fe75d1271adcd71cbdd50857d0f54", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26741, "upload_time": "2015-07-03T08:39:27", "url": "https://files.pythonhosted.org/packages/b3/7e/4443a8d2aaf29ecd30e4f50004ef6d9baba807ee0daec248bc04c982a96d/nexiles.tools.api-0.4.tar.gz" } ] }