{"id":21734719,"url":"https://github.com/ansys/pyconverter-xml2py","last_synced_at":"2025-07-06T18:33:36.979Z","repository":{"id":176590308,"uuid":"629509092","full_name":"ansys/pyconverter-xml2py","owner":"ansys","description":"A Python wrapper to convert XML documentation into Python source code with its Sphinx documentation.","archived":false,"fork":false,"pushed_at":"2025-06-30T13:48:07.000Z","size":6260,"stargazers_count":6,"open_issues_count":50,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-30T13:53:04.118Z","etag":null,"topics":["ast-tree","converter","dita","documentation-generator","package-generator","python","sphinx-doc","xml"],"latest_commit_sha":null,"homepage":"https://pyconverter-xml2py.docs.pyansys.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ansys.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-18T13:06:51.000Z","updated_at":"2025-06-28T02:21:39.000Z","dependencies_parsed_at":"2023-09-24T06:53:09.900Z","dependency_job_id":"1ca217ad-3b49-456c-8967-480a2c0f2ad2","html_url":"https://github.com/ansys/pyconverter-xml2py","commit_stats":null,"previous_names":["ansys/pydita-ast"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ansys/pyconverter-xml2py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpyconverter-xml2py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpyconverter-xml2py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpyconverter-xml2py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpyconverter-xml2py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansys","download_url":"https://codeload.github.com/ansys/pyconverter-xml2py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpyconverter-xml2py/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263951972,"owners_count":23534832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ast-tree","converter","dita","documentation-generator","package-generator","python","sphinx-doc","xml"],"created_at":"2024-11-26T05:10:16.542Z","updated_at":"2025-07-06T18:33:36.941Z","avatar_url":"https://github.com/ansys.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"PyConverter-XML2Py\n==================\n\nA Python wrapper to convert XML documentation into Python source code\nwith its related Sphinx documentation.\n\n|pyansys| |pypi| |GH-CI| |codecov| |MIT| |black|\n\n.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC\n   :target: https://docs.pyansys.com/\n   :alt: PyAnsys\n\n.. |pypi| image:: https://img.shields.io/pypi/v/pyconverter-xml2py.svg?logo=python\u0026logoColor=white\n   :target: https://pypi.org/project/pyconverter-xml2py/\n\n.. |codecov| image:: https://codecov.io/gh/ansys/pyconverter-xml2py/branch/main/graph/badge.svg\n   :target: https://codecov.io/gh/ansys/pyconverter-xml2py\n\n.. |GH-CI| image:: https://github.com/ansys/pyconverter-xml2py/actions/workflows/ci_cd.yml/badge.svg\n   :target: https://github.com/ansys/pyconverter-xml2py/actions/workflows/ci_cd.yml\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n   :target: https://opensource.org/licenses/MIT\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat\n  :target: https://github.com/psf/black\n  :alt: black\n\n\nOverview\n--------\n\nThe PyConverter-XML2Py project aims to automatically generate a Python library and a related \nSphinx documentation from an XML documentation.\n\n\nDocumentation and issues\n------------------------\n\nOn the `PyConverter-XML2Py Issues \u003chttps://github.com/ansys/pyconverter-xml2py/issues\u003e`_ for this repository,\nyou can create issues to submit questions, report bugs, and request new features. \nTo reach the PyAnsys support team, email `pyansys.core@ansys.com \u003cpyansys.core@ansys.com\u003e`_.\n\n\nGetting started\n---------------\n\nInstall the ``pyconverter-xml2py`` package with:\n\n.. code:: bash\n\n    python -m pip install pyconverter-xml2py\n\n\nIt is recommended to organize the XML documentation as follow:\n\n.. image:: ./doc/source/user_guide/images/diags/graphviz-diag_directory.png\n   :width: 450\n   :align: center\n\n\nConverting an XML-directory\n---------------------------\n\nOnce the ``XML_directory`` is correctly organized, the converter can be run.\n\n.. code:: bash\n\n    pyconverter-xml2py package -x XML_directory_path\n\nIf some functions need to be customized, the path containing the python \nfiles can be specified.\n\n.. code:: bash\n\n    pyconverter-xml2py package -x XML_directory_path -f customized_function_directory_path\n\n\nA new package is then automatically generated. Its default name is ``package``.\nIt is organized as follow:\n\n.. image:: ./doc/source/user_guide/images/diags/graphviz-diag_package.png\n   :width: 450\n   :align: center\n   \nThen, the Sphinx documentation can be generated from this package.\nThe following code is to render the documentation as an HTML one from Windows:\n\n.. code:: bash\n\n    cd package\n    pip install -e .[doc,tests] # Using a virtual environment is recommended.\n    .\\doc\\make.bat html \n   \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansys%2Fpyconverter-xml2py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansys%2Fpyconverter-xml2py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansys%2Fpyconverter-xml2py/lists"}