{"id":21734694,"url":"https://github.com/ansys/pydynamicreporting","last_synced_at":"2025-10-13T07:11:09.648Z","repository":{"id":180509446,"uuid":"657169596","full_name":"ansys/pydynamicreporting","owner":"ansys","description":"Pyansys project for Ansys Dynamic Reporting, a report generator tool.","archived":false,"fork":false,"pushed_at":"2025-10-06T20:20:17.000Z","size":95354,"stargazers_count":10,"open_issues_count":27,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-06T21:06:01.869Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://dynamicreporting.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.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-22T13:19:26.000Z","updated_at":"2025-10-06T15:22:30.000Z","dependencies_parsed_at":"2024-01-16T06:33:17.581Z","dependency_job_id":"b3e21266-65ab-435b-b17c-8f809e7046d4","html_url":"https://github.com/ansys/pydynamicreporting","commit_stats":null,"previous_names":["ansys/pydynamicreporting"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ansys/pydynamicreporting","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydynamicreporting","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydynamicreporting/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydynamicreporting/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydynamicreporting/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansys","download_url":"https://codeload.github.com/ansys/pydynamicreporting/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydynamicreporting/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279014106,"owners_count":26085461,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-26T05:10:11.277Z","updated_at":"2025-10-13T07:11:04.624Z","avatar_url":"https://github.com/ansys.png","language":"Python","readme":"PyDynamicReporting\n==================\n\n|pyansys| |python| |pypi| |GH-CI| |bandit| |MIT| |black|\n\n.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black\u0026logo=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.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-dynamicreporting-core?logo=pypi\n   :target: https://pypi.org/project/ansys-dynamicreporting-core/\n   :alt: Python\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ansys-dynamicreporting-core.svg?logo=python\u0026logoColor=white\n   :target: https://pypi.org/project/ansys-dynamicreporting-core\n   :alt: PyPI\n\n.. |GH-CI| image:: https://github.com/ansys/pydynamicreporting/actions/workflows/ci_cd.yml/badge.svg?branch=main\n   :target: https://github.com/ansys/pydynamicreporting/actions?query=branch%3Amain\n   :alt: GH-CI\n\n.. |bandit| image:: https://img.shields.io/badge/security-bandit-yellow.svg\n    :target: https://github.com/PyCQA/bandit\n    :alt: Security Status\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n   :target: https://opensource.org/licenses/MIT\n   :alt: 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.. _Nexus: https://nexusdemo.ensight.com/docs/html/Nexus.html\n\nOverview\n--------\nPyDynamicReporting is the Python client library for Ansys Dynamic Reporting,\npreviously documented as `Nexus`_. Ansys Dynamic Reporting is a service for\npushing items of many types, including images, text, 3D scenes, and tables,\ninto a database, where you can keep them organized and create dynamic reports\nfrom them. When you use PyDynamicReporting to connect to an instance of\nAnsys Dynamic Reporting, you have a Pythonic way of accessing all capabilities\nof Ansys Dynamic Reporting.\n\nDocumentation and issues\n------------------------\nDocumentation for the latest stable release of PyDynamicReporting is hosted at\n`PyDynamicReporting documentation \u003chttps://dynamicreporting.docs.pyansys.com/version/stable/\u003e`_.\n\nIn the upper right corner of the documentation's title bar, there is an option\nfor switching from viewing the documentation for the latest stable release\nto viewing the documentation for the development version or previously\nreleased versions.\n\nYou can also `view \u003chttps://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.png\u003e`_ or\n`download \u003chttps://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.pdf\u003e`_ the\nPyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands\nfor using PyDynamicReporting.\n\nOn the `PyDynamicReporting Issues \u003chttps://github.com/ansys/pydynamicreporting/issues\u003e`_\npage, you can create issues to report bugs and request new features. On the `Discussions \u003chttps://discuss.ansys.com/\u003e`_\npage on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.\n\nTo reach the project support team, email `pyansys.core@ansys.com \u003cpyansys.core@ansys.com\u003e`_.\n\nInstallation\n------------\nThe ``pydynamicreporting`` package supports Python 3.10 through 3.12 on\nWindows and Linux. It is currently available on the PyPi\n`repository \u003chttps://pypi.org/project/ansys-dynamicreporting-core/\u003e`_.\n\nTo install the package, simply run\n\n.. code::\n\n   pip install ansys-dynamicreporting-core\n\nDeveloper installation\n^^^^^^^^^^^^^^^^^^^^^^\nTo clone and install the ``pydynamicreporting`` package in development mode,\nrun this code:\n\n.. code::\n\n   git clone https://github.com/ansys/pydynamicreporting\n   cd pydynamicreporting\n   pip install virtualenv\n   virtualenv venv  # create virtual environment\n   source venv/bin/activate  # (.\\venv\\Scripts\\activate for Windows shell)\n   make install-dev  # install pydynamicreporting in editable mode\n\nThe preceding code creates an \"editable\" installation that lets you develop and test\nPyDynamicReporting at the same time.\n\nTo build and create a production-like installation, first install\n`chocolatey \u003chttps://chocolatey.org/install\u003e`_. Then:\n\n.. code::\n\n   choco install make  # install make\n   make clean  # clean\n   make build   # build\n   # this replaces the editable installation done previously. If you don't want to replace,\n   # switch your virtual environments to test the new install separately.\n   make install\n   # you can skip the steps above and just do 'make all'\n   make smoketest  # test import\n\nLocal GitHub Actions\n^^^^^^^^^^^^^^^^^^^^\nTo run GitHub Actions on your local desktop (recommended), install the\n`act \u003chttps://github.com/nektos/act#readme\u003e`_ package.\n\n.. code::\n\n   choco install act-cli\n\nTo run a job, such as the ``style`` job from the ``ci_cd.yml`` file, use\nthis command, where ``style`` is the job name:\n\n.. code::\n\n   act -W '.github/workflows/ci_cd.yml' -j style --bind\n\n\nDeploy and upload steps **must always** be ignored. If they are not ignored,\nbefore running GitHub Actions locally, add ``if: ${{ !env.ACT }}`` to the\nworkflow step and commit this change if required.\n\nDependencies\n------------\nTo use PyDynamicReporting, you must have a locally installed and licensed copy\nof Ansys 2023 R2 or later.\n\nTo use PyDynamicReporting Serverless (ansys.dynamicreporting.core.serverless),\nyou must have a locally installed and licensed copy of Ansys 2025 R1 or later.\n\nBasic usage\n-----------\nThis code shows how to start the simplest PyDynamicReporting session:\n\n.. code:: pycon\n\n    \u003e\u003e\u003e import ansys.dynamicreporting.core as adr\n    \u003e\u003e\u003e adr_service = adr.Service(ansys_installation=r\"C:\\Program Files\\ANSYS Inc\\v232\")\n    \u003e\u003e\u003e ret = adr_service.connect()\n    \u003e\u003e\u003e my_img = adr_service.create_item()\n    \u003e\u003e\u003e my_img.item_image = \"image.png\"\n    \u003e\u003e\u003e adr_service.visualize_report()\n\n\nLicense and acknowledgements\n----------------------------\nPyDynamicReporting is licensed under the MIT license.\n\nPyDynamicReporting makes no commercial claim over Ansys whatsoever.\nThis library extends the functionality of Ansys Dynamic Reporting by\nadding a Python interface to Ansys Dynamic Reporting without changing\nthe core behavior or license of the original software. The use of\nPyDynamicReporting requires a legally licensed copy of an Ansys product\nthat supports Ansys Dynamic Reporting.\n\nTo get a copy of Ansys, visit the `Ansys \u003chttps://www.ansys.com/\u003e`_ website.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansys%2Fpydynamicreporting","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansys%2Fpydynamicreporting","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansys%2Fpydynamicreporting/lists"}