PyDynamicReporting
==================
|pyansys| |python| |pypi| |GH-CI| |bandit| |MIT| |black|
.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
:target: https://docs.pyansys.com/
:alt: PyAnsys
.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-dynamicreporting-core?logo=pypi
:target: https://pypi.org/project/ansys-dynamicreporting-core/
:alt: Python
.. |pypi| image:: https://img.shields.io/pypi/v/ansys-dynamicreporting-core.svg?logo=python&logoColor=white
:target: https://pypi.org/project/ansys-dynamicreporting-core
:alt: PyPI
.. |GH-CI| image:: https://github.com/ansys/pydynamicreporting/actions/workflows/ci_cd.yml/badge.svg?branch=main
:target: https://github.com/ansys/pydynamicreporting/actions?query=branch%3Amain
:alt: GH-CI
.. |bandit| image:: https://img.shields.io/badge/security-bandit-yellow.svg
:target: https://github.com/PyCQA/bandit
:alt: Security Status
.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
:target: https://github.com/psf/black
:alt: Black
.. _Nexus: https://nexusdemo.ensight.com/docs/html/Nexus.html
Overview
--------
PyDynamicReporting is the Python client library for Ansys Dynamic Reporting,
previously documented as `Nexus`_. Ansys Dynamic Reporting is a service for
pushing items of many types, including images, text, 3D scenes, and tables,
into a database, where you can keep them organized and create dynamic reports
from them. When you use PyDynamicReporting to connect to an instance of
Ansys Dynamic Reporting, you have a Pythonic way of accessing all capabilities
of Ansys Dynamic Reporting.
Documentation and issues
------------------------
Documentation for the latest stable release of PyDynamicReporting is hosted at
`PyDynamicReporting documentation <https://dynamicreporting.docs.pyansys.com/version/stable/>`_.
In the upper right corner of the documentation's title bar, there is an option
for switching from viewing the documentation for the latest stable release
to viewing the documentation for the development version or previously
released versions.
You can also `view <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.png>`_ or
`download <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.pdf>`_ the
PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands
for using PyDynamicReporting.
On the `PyDynamicReporting Issues <https://github.com/ansys/pydynamicreporting/issues>`_
page, you can create issues to report bugs and request new features. On the `Discussions <https://discuss.ansys.com/>`_
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
Installation
------------
The ``pydynamicreporting`` package supports Python 3.9 through 3.12 on
Windows and Linux. It is currently available on the PyPi
`repository <https://pypi.org/project/ansys-dynamicreporting-core/>`_.
To install the package, simply run
.. code::
pip install ansys-dynamicreporting-core
Alternatively, the user can download the repository and locally build the
package. Two modes of installation are available:
- Developer installation
- User installation
The code provided for both installation modes use a `virtual environment
<https://docs.python.org/3/library/venv.html>`_.
Developer installation
^^^^^^^^^^^^^^^^^^^^^^
To clone and install the ``pydynamicreporting`` package in development mode,
run this code:
.. code::
git clone https://github.com/ansys/pydynamicreporting
cd pydynamicreporting
pip install virtualenv
virtualenv venv # create virtual environment
source venv/bin/activate # (.\venv\Scripts\activate for Windows shell)
make install-dev # install pydynamicreporting in editable mode
The preceding code creates an "editable" installation that lets you develop and test
PyDynamicReporting at the same time.
User installation
^^^^^^^^^^^^^^^^^
To build and create a production-like installation for use, run this code:
.. code::
make clean # clean
make build # build
# this replaces the editable installation done previously. If you don't want to replace,
# switch your virtual environments to test the new install separately.
make install
# you can skip the steps above and just do 'make all'
make smoketest # test import
Pre-commit setup
^^^^^^^^^^^^^^^^
`pre-commit <https://pre-commit.com/>`_ is a framework for managing and
maintaining multi-language pre-commit hooks.
To install the ``pre-commit`` package into your Git hooks, run this command:
.. code::
pre-commit install
``pre-commit`` now runs on every commit.
Each time you clone a project, installing the ``pre-commit`` package
should always be the first thing that you do.
If you want to manually run all pre-commit hooks on a repository, run
this command:
.. code::
pre-commit run --all-files
The preceding command runs a bunch of formatters on your source files.
To run an individual hook, obtain the hook ID from the project's
``.pre-commit-config.yaml`` file and then run this code,
where ``<hook_id>`` is the obtained ID:
.. code::
pre-commit run <hook_id>
The first time ``pre-commit`` runs on a file, it automatically downloads,
installs, and runs the hook.
Local GitHub Actions
^^^^^^^^^^^^^^^^^^^^
To run GitHub Actions on your local desktop (recommended), install the
`act <https://github.com/nektos/act#readme>`_ package.
To run a job, such as the ``docs`` job from the ``ci_cd.yml`` file, use
this command, where ``docs`` is the job name:
.. code::
act -j docs
Deploy and upload steps **must always** be ignored. If they are not ignored,
before running GitHub Actions locally, add ``if: ${{ !env.ACT }}`` to the
workflow step and commit this change if required.
Dependencies
------------
To use PyDynamicReporting, you must have a locally installed and licensed copy
of Ansys 2023 R2 or later.
Basic usage
-----------
This code shows how to start the simplest PyDynamicReporting session:
.. code:: pycon
>>> import ansys.dynamicreporting.core as adr
>>> adr_service = adr.Service(ansys_installation=r"C:\Program Files\ANSYS Inc\v232")
>>> ret = adr_service.connect()
>>> my_img = adr_service.create_item()
>>> my_img.item_image = "image.png"
>>> adr_service.visualize_report()
License and acknowledgements
----------------------------
PyDynamicReporting is licensed under the MIT license.
PyDynamicReporting makes no commercial claim over Ansys whatsoever.
This library extends the functionality of Ansys Dynamic Reporting by
adding a Python interface to Ansys Dynamic Reporting without changing
the core behavior or license of the original software. The use of
PyDynamicReporting requires a legally licensed copy of an Ansys product
that supports Ansys Dynamic Reporting.
To get a copy of Ansys, visit the `Ansys <https://www.ansys.com/>`_ website.
Raw data
{
"_id": null,
"home_page": null,
"name": "ansys-dynamicreporting-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"ANSYS, Inc.\" <pyansys.core@ansys.com>, Ansys ADR Team <nexus@ansys.com>",
"keywords": "dynamicreporting, pydynamicreporting, pyansys, ansys",
"author": null,
"author_email": "\"ANSYS, Inc.\" <pyansys.core@ansys.com>",
"download_url": "https://files.pythonhosted.org/packages/47/f2/08adfed4cdf67e1592b9ce29df7b1bd46e05a4d2151cad93212950abbb89/ansys_dynamicreporting_core-0.6.0.tar.gz",
"platform": null,
"description": "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&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.. |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&logoColor=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 <https://dynamicreporting.docs.pyansys.com/version/stable/>`_.\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 <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.png>`_ or\n`download <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.pdf>`_ the\nPyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands\nfor using PyDynamicReporting.\n\nOn the `PyDynamicReporting Issues <https://github.com/ansys/pydynamicreporting/issues>`_\npage, you can create issues to report bugs and request new features. On the `Discussions <https://discuss.ansys.com/>`_\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 <pyansys.core@ansys.com>`_.\n\nInstallation\n------------\nThe ``pydynamicreporting`` package supports Python 3.9 through 3.12 on\nWindows and Linux. It is currently available on the PyPi\n`repository <https://pypi.org/project/ansys-dynamicreporting-core/>`_.\n\nTo install the package, simply run\n\n.. code::\n\n pip install ansys-dynamicreporting-core\n\n\nAlternatively, the user can download the repository and locally build the\npackage. Two modes of installation are available:\n\n- Developer installation\n- User installation\n\n\nThe code provided for both installation modes use a `virtual environment\n<https://docs.python.org/3/library/venv.html>`_.\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\n\nThe preceding code creates an \"editable\" installation that lets you develop and test\nPyDynamicReporting at the same time.\n\nUser installation\n^^^^^^^^^^^^^^^^^\nTo build and create a production-like installation for use, run this code:\n\n.. code::\n\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\n\nPre-commit setup\n^^^^^^^^^^^^^^^^\n\n`pre-commit <https://pre-commit.com/>`_ is a framework for managing and\nmaintaining multi-language pre-commit hooks.\n\nTo install the ``pre-commit`` package into your Git hooks, run this command:\n\n.. code::\n\n pre-commit install\n\n\n``pre-commit`` now runs on every commit.\n\nEach time you clone a project, installing the ``pre-commit`` package\nshould always be the first thing that you do.\n\nIf you want to manually run all pre-commit hooks on a repository, run\nthis command:\n\n.. code::\n\n pre-commit run --all-files\n\n\nThe preceding command runs a bunch of formatters on your source files.\n\nTo run an individual hook, obtain the hook ID from the project's\n``.pre-commit-config.yaml`` file and then run this code,\nwhere ``<hook_id>`` is the obtained ID:\n\n.. code::\n\n pre-commit run <hook_id>\n\n\nThe first time ``pre-commit`` runs on a file, it automatically downloads,\ninstalls, and runs the hook.\n\n\nLocal GitHub Actions\n^^^^^^^^^^^^^^^^^^^^\nTo run GitHub Actions on your local desktop (recommended), install the\n`act <https://github.com/nektos/act#readme>`_ package.\n\nTo run a job, such as the ``docs`` job from the ``ci_cd.yml`` file, use\nthis command, where ``docs`` is the job name:\n\n.. code::\n\n act -j docs\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\nBasic usage\n-----------\nThis code shows how to start the simplest PyDynamicReporting session:\n\n.. code:: pycon\n\n >>> import ansys.dynamicreporting.core as adr\n >>> adr_service = adr.Service(ansys_installation=r\"C:\\Program Files\\ANSYS Inc\\v232\")\n >>> ret = adr_service.connect()\n >>> my_img = adr_service.create_item()\n >>> my_img.item_image = \"image.png\"\n >>> 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 <https://www.ansys.com/>`_ website.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python interface to Ansys Dynamic Reporting",
"version": "0.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/ansys/pydynamicreporting/issues",
"changelog": "https://github.com/ansys/pydynamicreporting/blob/main/CHANGELOG.rst",
"ci": "https://github.com/ansys/pydynamicreporting/actions",
"documentation": "https://dynamicreporting.docs.pyansys.com/",
"homepage": "https://github.com/ansys/pydynamicreporting",
"repository": "https://github.com/ansys/pydynamicreporting"
},
"split_keywords": [
"dynamicreporting",
" pydynamicreporting",
" pyansys",
" ansys"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9cb85499966fec2a999e739b3d2bc4dd9c93ed499b6a1c4953be364825f3151",
"md5": "ae50cb22f1f077b24b47a9070ddb60b9",
"sha256": "ed9ed52c2cbeec58af4bd5d64011c438ff6c95597f59daa77cf3772f72429595"
},
"downloads": -1,
"filename": "ansys_dynamicreporting_core-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae50cb22f1f077b24b47a9070ddb60b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 98997,
"upload_time": "2024-04-15T16:29:56",
"upload_time_iso_8601": "2024-04-15T16:29:56.664386Z",
"url": "https://files.pythonhosted.org/packages/d9/cb/85499966fec2a999e739b3d2bc4dd9c93ed499b6a1c4953be364825f3151/ansys_dynamicreporting_core-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47f208adfed4cdf67e1592b9ce29df7b1bd46e05a4d2151cad93212950abbb89",
"md5": "e4423ee92d6a97764f84cd564ab33cd1",
"sha256": "0b7aa7107703f635f6ecbfe5b0b24a80b65297c86522498feaeec5f88e50988c"
},
"downloads": -1,
"filename": "ansys_dynamicreporting_core-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "e4423ee92d6a97764f84cd564ab33cd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7788830,
"upload_time": "2024-04-15T16:29:59",
"upload_time_iso_8601": "2024-04-15T16:29:59.481453Z",
"url": "https://files.pythonhosted.org/packages/47/f2/08adfed4cdf67e1592b9ce29df7b1bd46e05a4d2151cad93212950abbb89/ansys_dynamicreporting_core-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 16:29:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "pydynamicreporting",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ansys-dynamicreporting-core"
}
JSON
