ansys-dynamicreporting-core 0.4.0__tar.gz

ansys-dynamicreporting-core-0.4.0/.ci/pull_adr_image.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -ex
+
+# Image name
+_IMAGE_NAME="ghcr.io/ansys-internal/nexus_dev"
+
+# Pull Ansys Dynamic Reporting image based on tag
+docker pull $_IMAGE_NAME
+
+# Remove all dangling images
+docker image prune -f

ansys-dynamicreporting-core-0.4.0/.flake8

@@ -0,0 +1,40 @@
+[flake8]
+exclude = venv, __init__.py, doc/_build
+select = B,B9,C,D,DAR,E,F,N,RST,S,W
+count = True
+max-complexity = 10
+max-line-length = 100
+statistics = True
+ignore =
+  # Whitespace before ':'.
+  E203,
+  # Line too long (82 > 79 characters).
+  E501,
+  # Line break occurred before a binary operator.
+  W503,
+  # Invalid escape sequence
+  W605,
+  # undefined name name
+  F821,
+  # Function is too complex
+  C901,
+  # https://docs.python.org/3/tutorial/errors.html#exception-chaining for details
+  B904,
+  # camelcase imported as lowercase
+  N813
+  #  Data class should either be immutable or use __slots__ to save memory
+  B903
+  # class name should use CapWords convention
+  N801
+  # function name should be lowercase
+  N802
+  # exception name should be named with an Error suffix
+  N818
+  # line too long
+  B950
+  # Module imported but unused
+  F401
+  # manually surrounded by quotes, consider using the `!r` conversion flag
+  B907
+  # zip() without an explicit strict= parameter set.
+  B905

ansys-dynamicreporting-core-0.4.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

ansys-dynamicreporting-core-0.4.0/.github/workflows/ci_cd.yml

@@ -0,0 +1,194 @@
+name: CI-CD
+
+# run only on main branch.  This avoids duplicated actions on PRs
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+      - release/*
+  push:
+    tags:
+      - "v*"
+    branches:
+      - main
+      - release/*
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  DOCUMENTATION_CNAME: 'dynamicreporting.docs.pyansys.com'
+  MAIN_PYTHON_VERSION: '3.10'
+  PACKAGE_NAME: 'ansys-dynamicreporting-core'
+  PACKAGE_NAMESPACE: 'ansys.dynamicreporting.core'
+
+jobs:
+  style:
+    name: Code style
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys code style checks
+        uses: ansys/actions/code-style@v4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  docs-style:
+    name: Documentation style check
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys documentation style checks
+        uses: ansys/actions/doc-style@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  smoke-tests:
+    name: Build and smoke tests
+    runs-on: ${{ matrix.os }}
+    needs: [style]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        should-release:
+          - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
+        exclude:
+          - should-release: false
+            os: macos-latest
+    steps:
+      - name: Build wheelhouse and perform smoke test
+        uses: ansys/actions/build-wheelhouse@v4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          library-namespace: ${{ env.PACKAGE_NAMESPACE }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python-version }}
+
+  test:
+    name: Testing
+    needs: [smoke-tests]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ '3.8', '3.9', '3.10', '3.11' ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pull Docker container
+        run: make pull-docker
+
+      - name: Run pytest
+        uses: ansys/actions/tests-pytest@v4
+        env:
+          ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER )}}
+        with:
+          checkout: false
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          pytest-extra-args: -rvx --setup-show --cov=ansys.dynamicreporting --cov-report html:coverage-html --cov-report term --cov-report xml:coverage.xml
+
+      - name: Upload coverage report
+        if: env.MAIN_PYTHON_VERSION == matrix.python-version
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage.xml
+          path: coverage.xml
+          retention-days: 60
+          if-no-files-found: error
+
+      - name: Upload coverage to Codecov
+        if: env.MAIN_PYTHON_VERSION == matrix.python-version
+        uses: codecov/codecov-action@v3
+
+  docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    needs: [docs-style]
+    steps:
+      - name: Run Ansys documentation building action
+        uses: ansys/actions/doc-build@v4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  package:
+    name: Package library
+    needs: [test, docs]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build library source and wheel artifacts
+        uses: ansys/actions/build-library@v4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  release:
+    name: Release project
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    needs: [package]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Release to the public PyPI repository
+        uses: ansys/actions/release-pypi-public@v4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          twine-username: "__token__"
+          twine-token: ${{ secrets.PYPI_TOKEN }}
+
+      - name: Release to GitHub
+        uses: ansys/actions/release-github@v4
+        if: ${{ !env.ACT }}
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+
+  upload_dev_docs:
+    name: Upload dev documentation
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: [package]
+    steps:
+      - name: Deploy the latest documentation
+        uses: ansys/actions/doc-deploy-dev@v4
+        if: ${{ !env.ACT }}
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  upload_docs_release:
+    name: Upload release documentation
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: [release]
+    steps:
+      - name: Deploy the stable documentation
+        uses: ansys/actions/doc-deploy-stable@v4
+        if: ${{ !env.ACT }}
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  build-failure:
+    name: Teams notify on failure
+    if: failure() && (github.event_name == 'pull_request' || github.ref == 'refs/heads/main' || github.ref_type == 'tag')
+    needs: [ style, test, docs-style ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Microsoft Teams Notification
+        uses: jdcargile/ms-teams-notification@v1.3
+        with:
+          github-token: ${{ github.token }} # this will use the runner's token.
+          ms-teams-webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI }}
+          notification-summary: GitHub CI failure - ${{ github.event.pull_request.title }}
+          notification-color: dc3545
+          timezone: America/New_York

ansys-dynamicreporting-core-0.4.0/.github/workflows/nightly-docs.yml

@@ -0,0 +1,34 @@
+name: Nightly Documentation Build
+
+on:
+  schedule:  # UTC at 0400 - 12am EDT
+    - cron:  '0 4 * * *'
+  workflow_dispatch:
+
+env:
+  DOCUMENTATION_CNAME: 'dynamicreporting.docs.pyansys.com'
+  MAIN_PYTHON_VERSION: '3.10'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  docs_build:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run Ansys documentation building action
+        uses: ansys/actions/doc-build@v4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  docs_upload:
+    needs: docs_build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy development documentation
+        uses: ansys/actions/doc-deploy-dev@v4
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}

ansys-dynamicreporting-core-0.4.0/.github/workflows/nightly.yml

@@ -0,0 +1,113 @@
+name: Nightly Build and Test
+
+on:
+  schedule:  # UTC at 0300 - 11pm EDT
+    - cron:  '0 3 * * *'
+  workflow_dispatch:
+
+env:
+  MAIN_PYTHON_VERSION: '3.10'
+  PACKAGE_NAME: 'ansys-dynamicreporting-core'
+  PACKAGE_NAMESPACE: 'ansys.dynamicreporting.core'
+
+
+jobs:
+
+  style:
+    name: Code style
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys code style checks
+        uses: ansys/actions/code-style@v4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  smoke-tests:
+    name: Build and smoke tests
+    runs-on: ${{ matrix.os }}
+    needs: [style]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+    steps:
+      - name: Build wheelhouse and perform smoke test
+        uses: ansys/actions/build-wheelhouse@v4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          library-namespace: ${{ env.PACKAGE_NAMESPACE }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python-version }}
+
+  nightly_test:
+    name: Testing
+    needs: [smoke-tests]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ '3.8', '3.9', '3.10', '3.11' ]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: 'refs/heads/main'
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pull Docker container
+        run: make pull-docker
+
+      - name: Run pytest
+        uses: ansys/actions/tests-pytest@v4
+        env:
+          ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER )}}
+        with:
+          checkout: false
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          pytest-extra-args: -rvx --setup-show --cov=ansys.dynamicreporting --cov-report html:coverage-html --cov-report term --cov-report xml:coverage.xml
+
+  nightly_and_upload:
+    name: nightly_and_upload
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build library source and wheel artifacts
+        uses: ansys/actions/build-library@v4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: Rename wheel
+        run: |
+          python codegen/rename_whl.py
+          rm -rf dist/*.tar.gz
+
+      - name: Upload to Azure PyPi
+        if: ${{ !env.ACT }}
+        run: twine upload --verbose dist/*
+        env:
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: ${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}
+          TWINE_REPOSITORY_URL: ${{ secrets.PRIVATE_PYPI_URL }}
+
+  build-failure:
+    name: Teams notify on failure
+    if: failure()
+    needs: [ nightly_test, nightly_and_upload]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Microsoft Teams Notification
+        uses: jdcargile/ms-teams-notification@v1.3
+        with:
+          github-token: ${{ github.token }}
+          ms-teams-webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI }}
+          notification-summary: Nightly failure
+          notification-color: dc3545
+          timezone: America/New_York

ansys-dynamicreporting-core-0.4.0/.gitignore

@@ -0,0 +1,72 @@
+# This is an example .gitignore and may need to be adapted per
+# project.
+
+# Compiled source #
+###################
+*.pyc
+*.pyd
+*.c
+*.cpp
+*.so
+*.o
+*.cache
+.pytest_cache/
+
+# OS generated files #
+######################
+.fuse_hidden*
+*~
+*swp
+.DS_Store
+
+# emacs
+flycheck*
+
+# Old files #
+_old/
+
+# Pip generated folders #
+#########################
+*.egg-info/
+build/
+dist/
+.venv
+
+# build intermediate products
+src/ansys/dynamicreporting/core/adr_item.py
+src/ansys/dynamicreporting/core/adr_utils.py
+src/ansys/dynamicreporting/core/build_info.py
+
+# autogenerated docs
+_autosummary
+doc/source/examples
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+test-output.xml
+coverage.xml
+coverage-html
+*.cover
+.hypothesis/
+.pytest_cache/
+
+
+\#*
+.\#*
+/.ipynb_checkpoints
+
+# PyCharm
+.idea/
+venv/
+*.bak
+
+# VSCode
+.vscode
+
+# Ignore Sphinx files
+doc/_build

ansys-dynamicreporting-core-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+repos:
+
+- repo: https://github.com/psf/black
+  rev: 23.3.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  hooks:
+  - id: black
+
+- repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.13.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies: [ black==23.3.0 ]
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.11.5
+  hooks:
+  - id: isort
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 5.0.4
+  hooks:
+  - id: flake8
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.4
+  hooks:
+  - id: codespell
+    args: ["--toml", "pyproject.toml"]
+    additional_dependencies: [ "tomli" ]
+
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.22.0
+  hooks:
+    - id: check-github-workflows
+
+# TO BE ACTIVATED EVENTUALLY - EXISTING ERRORS SHOULD BE SOLVED
+#
+# - repo: https://github.com/PyCQA/bandit
+#   rev: 1.7.5
+#   hooks:
+#   - id: bandit
+#     args: [ "-c", "pyproject.toml"]
+#     additional_dependencies: [ "bandit[toml]" ]
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.3.2
+  hooks:
+  - id: pyupgrade
+    args: [ --py37-plus ]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-yaml
+  - id: check-case-conflict
+  - id: debug-statements
+  - id: check-merge-conflict
+  - id: trailing-whitespace
+
+- repo: https://github.com/PyCQA/docformatter
+  rev: v1.6.3
+  hooks:
+  - id: docformatter
+    additional_dependencies: [ "tomli" ]
+
+# TO BE ACTIVATED EVENTUALLY - FORCES PROPER DOCSTRINGS
+#
+# - repo: https://github.com/pycqa/pydocstyle
+#   rev: 6.3.0
+#   hooks:
+#   - id: pydocstyle
+#     additional_dependencies: [ "tomli" ]
+#     exclude: "tests/"

ansys-dynamicreporting-core-0.4.0/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of PyDynamicReporting's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and wish to be added to this file
+# please submit a request.
+#
+#
+ANSYS, Inc.

ansys-dynamicreporting-core-0.4.0/CHANGELOG.rst

@@ -0,0 +1,9 @@
+=======
+History
+=======
+
+
+0.1.0 (01-01-1970)
+------------------
+
+* First release on PyPI.

ansys-dynamicreporting-core-0.4.0/CONTRIBUTING.rst

@@ -0,0 +1,14 @@
+Contributing
+############
+
+We absolutely welcome any code contributions and we hope that this
+guide will facilitate an understanding of the ``pydynamicreporting`` code
+repository. It is important to note that while the ``pydynamicreporting``
+software package is maintained by ANSYS and any submissions will be
+reviewed thoroughly before merging, we still seek to foster a community
+that can support user questions and develop new features to make this
+software a useful tool for all users.  As such, we welcome and encourage
+any questions or submissions to this repository.
+
+Please reference the `PyAnsys Developer's Guide <https://dev.docs.pyansys.com/>`_ for the full documentation
+regarding contributing to the ``pydynamicreporting`` project.

ansys-dynamicreporting-core-0.4.0/CONTRIBUTORS.md

@@ -0,0 +1,16 @@
+# Contributors
+
+## Project Lead
+
+* [Marina Galvagni](https://github.com/margalva)
+
+## Individual Contributors
+
+* [Chris Garrison](https://github.com/chrisg564)
+* [Cyrille Defranoux](https://github.com/cdan6)
+* [Germán Martínez Ayuso](https://github.com/germa89)
+* [Maxime Rey](https://github.com/MaxJPRey)
+* [Mike Krogh](https://github.com/mfkrogh)
+* [Randy Frank](https://github.com/randallfrank)
+* [Roberto Pastor](https://github.com/RobPasMue)
+* [Visesh Rajendraprasad](https://github.com/viseshrp)

ansys-dynamicreporting-core-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ANSYS, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ansys-dynamicreporting-core-0.4.0/Makefile

@@ -0,0 +1,53 @@
+CODESPELL_DIRS ?= ./pydynamicreporting
+CODESPELL_SKIP ?= "*.pyc,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac,\#*,PKG-INFO,*.mypy_cache/*,*.xml,*.aedt,*.svg"
+CODESPELL_IGNORE ?= "ignore_words.txt"
+
+doctest: codespell
+
+codespell:
+	echo "Running codespell"
+	codespell $(CODESPELL_DIRS) -S $(CODESPELL_SKIP) # -I $(CODESPELL_IGNORE)
+
+build:
+	python -m build --wheel
+	python codegen/rename_whl.py
+	rm -rf build
+
+build-nightly: build
+
+install:
+	pip uninstall ansys-dynamicreporting-core -y
+	pip install dist/*.whl
+
+install-dev:
+	python -m pip install --upgrade pip
+	pip uninstall ansys-dynamicreporting-core -y
+	pip install -e .[dev]
+
+pull-docker:
+	bash .ci/pull_adr_image.sh
+
+test:
+	pytest -rvx --setup-show --cov=ansys.dynamicreporting.core \
+ 	--cov-report html:coverage-html \
+	--cov-report term \
+	--cov-report xml:coverage.xml
+
+smoketest:
+	python -c "from ansys.dynamicreporting.core import __version__; print(__version__)"
+	python -c "from ansys.dynamicreporting.core import Service"
+
+clean:
+	rm -rf dist build
+	rm -f src/ansys/dynamicreporting/core/adr_item.py
+	rm -f src/ansys/dynamicreporting/core/adr_utils.py
+	rm -f src/ansys/dynamicreporting/core/build_info.py
+	rm -rf **/*.egg-info
+	rm -rf coverage-html
+	rm -rf .pytest_cache
+	find . -name \*.pyc -delete
+
+test_clean:
+	python test_cleanup.py
+
+all: clean build install