{ "info": { "author": "Alex Mykyta", "author_email": "amykyta3@github.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)" ], "description": "[![Build Status](https://travis-ci.org/SystemRDL/RALBot-ipxact.svg?branch=master)](https://travis-ci.org/SystemRDL/RALBot-ipxact)\n[![Coverage Status](https://coveralls.io/repos/github/SystemRDL/RALBot-ipxact/badge.svg?branch=master)](https://coveralls.io/github/SystemRDL/RALBot-ipxact?branch=master)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ralbot-ipxact.svg)](https://pypi.org/project/ralbot-ipxact)\n\n# RALBot-ipxact\nThis package implements IP-XACT import and export for the RALBot toolchain\n\n- **Export:** Convert compiled SystemRDL input into IP-XACT XML\n- **Import:** Read an IP-XACT file and import it into the `systemrdl-compiler` namespace\n\n## Installing\nInstall from [PyPi](https://pypi.org/project/ralbot-ipxact) using pip:\n\n python3 -m pip install ralbot-ipxact\n\n--------------------------------------------------------------------------------\n\n## Exporter Usage\nPass the elaborated output of the [SystemRDL Compiler](http://systemrdl-compiler.readthedocs.io)\nto the exporter.\n\n```python\nimport sys\nfrom systemrdl import RDLCompiler, RDLCompileError\nfrom ralbot.ipxact import IPXACTExporter\n\nrdlc = RDLCompiler()\n\ntry:\n rdlc.compile_file(\"path/to/my.rdl\")\n root = rdlc.elaborate()\nexcept RDLCompileError:\n sys.exit(1)\n\nexporter = IPXACTExporter()\n\nexporter.export(root, \"path/to/output.xml\")\n```\n\n## Importer Usage\nWhen an IP-XACT file is imported, the register description is loaded into the\nSystemRDL register model as if it was an `addrmap` component declaration.\nOnce imported, the IP-XACT contents can be used as-is, or referenced from\nanother RDL file.\n\nImport can occur at any point alongside normal RDL file compilation.\n\n```python\nimport sys\nfrom systemrdl import RDLCompiler, RDLCompileError\nfrom ralbot.ipxact import IPXACTImporter\n\nrdlc = RDLCompiler()\nipxact = IPXACTImporter(rdlc)\n\ntry:\n ipxact.import_file(\"path/to/my_ipxact.xml\")\n rdlc.compile_file(\"path/to/my.rdl\")\n root = rdlc.elaborate()\nexcept RDLCompileError:\n sys.exit(1)\n```\n--------------------------------------------------------------------------------\n\n## Reference\n\n### `IPXACTExporter(**kwargs)`\nConstructor for the IP-XACT exporter class\n\n**Optional Parameters**\n\n* `vendor`\n * Vendor url string. Defaults to \"example.org\"\n* `library`\n * library name string. Defaults to \"mylibrary\"\n* `version`\n * Version string. Defaults to \"1.0\"\n* `standard`\n * IP-XACT Standard to use. Currently supports:\n * `ralbot.ipxact.Standard.IEEE_1685_2009`\n * `ralbot.ipxact.Standard.IEEE_1685_2014`\n * Defaults to IEEE Std 1685-2014\n* `xml_indent`\n * String to use for each indent level. Defaults to 2 spaces.\n* `xml_newline`\n * String to use for line breaks. Defaults to newline.\n\n### `IPXACTExporter.export(node, path)`\nPerform the export!\n\n**Parameters**\n\n* `node`\n * Top-level node to export. Can be the top-level `RootNode` or any internal `AddrmapNode`.\n* `path`\n * Output file.\n\n### `IPXACTImporter(compiler)`\nConstructor for the IP-XACT importer class\n\n* `compiler`\n * Reference to `RDLCompiler` instance to bind the importer to\n\n### `IPXACTImporter.import_file(path)`\nPerform the import!\n\n* `path`\n * Input IP-XACT file.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/SystemRDL/RALBot-ipxact", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "ralbot-ipxact", "package_url": "https://pypi.org/project/ralbot-ipxact/", "platform": "", "project_url": "https://pypi.org/project/ralbot-ipxact/", "project_urls": { "Homepage": "https://github.com/SystemRDL/RALBot-ipxact", "Source": "https://github.com/SystemRDL/RALBot-ipxact", "Tracker": "https://github.com/SystemRDL/RALBot-ipxact/issues" }, "release_url": "https://pypi.org/project/ralbot-ipxact/1.3.0/", "requires_dist": null, "requires_python": ">=3.4", "summary": "Import and export IP-XACT XML to/from the systemrdl-compiler register model", "version": "1.3.0" }, "last_serial": 5921805, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "dca8fd178b3094fc78db6cd98e09e3e1", "sha256": "93f6a50189c8ffbbfc36307b14a9db1450fd98995e78436d6d1ba2f1082b94a6" }, "downloads": -1, "filename": "ralbot-ipxact-1.0.0.tar.gz", "has_sig": false, "md5_digest": "dca8fd178b3094fc78db6cd98e09e3e1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4866, "upload_time": "2018-11-07T06:42:42", "url": "https://files.pythonhosted.org/packages/c6/25/ef4db52434ac32fc5e8664b2b7cea32d0cecfb12d395a19b58df7d20c723/ralbot-ipxact-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "79bdd37a86e99be45dcbe84d651e8ec3", "sha256": "94a8228d64dfb88efe8a8173219e63b6c43d72e7fa523c4f75582a6efe03984e" }, "downloads": -1, "filename": "ralbot-ipxact-1.1.0.tar.gz", "has_sig": false, "md5_digest": "79bdd37a86e99be45dcbe84d651e8ec3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12593, "upload_time": "2019-02-10T23:08:26", "url": "https://files.pythonhosted.org/packages/17/f7/eec800e8dd31cbedcabc602fe662023a9e5b84e7af0a9e6795612f925de8/ralbot-ipxact-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "2cd47e2150d169e355c7db21577bbb5e", "sha256": "5c598447991f0394623d1813a870206ae4da2f7c6bbd89d8596edf14e701bcd5" }, "downloads": -1, "filename": "ralbot-ipxact-1.2.0.tar.gz", "has_sig": false, "md5_digest": "2cd47e2150d169e355c7db21577bbb5e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12838, "upload_time": "2019-06-25T03:06:13", "url": "https://files.pythonhosted.org/packages/63/88/db1218a10505402442bb32e0db6fcd29c9d4e9500c0cbdd93e9c1f8dac68/ralbot-ipxact-1.2.0.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "8eed1239dddb9f17084878c35d7ff639", "sha256": "d72181d4e0f8226ec42de3e98f37bdf04a1589dbf54deb381c3c83f5309ec537" }, "downloads": -1, "filename": "ralbot-ipxact-1.2.1.tar.gz", "has_sig": false, "md5_digest": "8eed1239dddb9f17084878c35d7ff639", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12861, "upload_time": "2019-08-07T04:38:19", "url": "https://files.pythonhosted.org/packages/ad/39/d4bc759d152d12b220d8f5f36f44f01427089c943acbaedb5aec2a93d4c4/ralbot-ipxact-1.2.1.tar.gz" } ], "1.2.2": [ { "comment_text": "", "digests": { "md5": "bec5935ee8c968d85d4865035b2e3e1d", "sha256": "3d294d8e4eb5befe7d0606a24308d7595681a1e023de06046f93396e33d0b08e" }, "downloads": -1, "filename": "ralbot-ipxact-1.2.2.tar.gz", "has_sig": false, "md5_digest": "bec5935ee8c968d85d4865035b2e3e1d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12857, "upload_time": "2019-08-16T02:36:07", "url": "https://files.pythonhosted.org/packages/c1/26/4b2ea0f4c4633c32a55eb8b3b1ce9c505e8372b188797460e9d2685c012d/ralbot-ipxact-1.2.2.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "b5f994e82c5ff7b7fcd3c747f3b3b348", "sha256": "353be2d9ee4586442aca8b4fc804f704f1fbc6ab940e9febd24a19a92bc86ada" }, "downloads": -1, "filename": "ralbot-ipxact-1.3.0.tar.gz", "has_sig": false, "md5_digest": "b5f994e82c5ff7b7fcd3c747f3b3b348", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 13429, "upload_time": "2019-10-03T05:18:29", "url": "https://files.pythonhosted.org/packages/7e/20/5ca6e86137f09809f951f1a30259c88fe68ab94356be7ebbec91ad1647a6/ralbot-ipxact-1.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b5f994e82c5ff7b7fcd3c747f3b3b348", "sha256": "353be2d9ee4586442aca8b4fc804f704f1fbc6ab940e9febd24a19a92bc86ada" }, "downloads": -1, "filename": "ralbot-ipxact-1.3.0.tar.gz", "has_sig": false, "md5_digest": "b5f994e82c5ff7b7fcd3c747f3b3b348", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 13429, "upload_time": "2019-10-03T05:18:29", "url": "https://files.pythonhosted.org/packages/7e/20/5ca6e86137f09809f951f1a30259c88fe68ab94356be7ebbec91ad1647a6/ralbot-ipxact-1.3.0.tar.gz" } ] }