Merge from grantami-bomanalytics-private

.github/workflows/ci_cd.yml

@@ -29,17 +29,9 @@ jobs:
     needs: local_checks
     if: ${{ !startsWith( github.event.pull_request.head.ref, 'dependabot/') }}
     uses: ./.github/workflows/server_checks.yml
-    secrets:
-      AZURE_APP_ID: ${{ secrets.AZURE_APP_ID }}
-      AZURE_SECRET: ${{ secrets.AZURE_SECRET }}
-      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
-      AZURE_RESOURCE_GROUP: ${{ secrets.AZURE_RESOURCE_GROUP }}
-      AZURE_VM_NAME: ${{ secrets.AZURE_VM_NAME }}
-      TEST_SERVER_URL: ${{ secrets.TEST_SERVER_URL }}
-      TEST_SERVER_READ_USER: ${{ secrets.TEST_SERVER_READ_USER }}
-      TEST_SERVER_READ_PASS: ${{ secrets.TEST_SERVER_READ_PASS }}
-      TEST_SERVER_WRITE_USER: ${{ secrets.TEST_SERVER_WRITE_USER }}
-      TEST_SERVER_WRITE_PASS: ${{ secrets.TEST_SERVER_WRITE_PASS }}
+    with:
+      skip-vm-management: ${{ vars.SKIP_VM_MANAGEMENT == 'true' }}
+    secrets: inherit
 
   doc-deploy-dev:
     name: "Deploy development documentation"

.github/workflows/local_checks.yml

@@ -8,24 +8,11 @@ env:
   MAIN_PYTHON_VERSION: '3.9'
 
 jobs:
-  style:
-    name: Code Style Check
+  code-style:
+    name: "Code Style Check"
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
-
-      - name: Install style requirements
-        run: pip install 'tox<4' poetry --disable-pip-version-check
-
-      - name: Spell, Lint and Type Check
-        run: tox -e style
-
+      - uses: ansys/actions/code-style@v4
 
   docs-style:
     name: Documentation Style Check
@@ -35,19 +22,22 @@ jobs:
         uses: ansys/actions/doc-style@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          vale-version: "2.29.6"
 
   unit_tests:
     name: Unit tests
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10', '3.11' ]
+        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
     steps:
       - uses: actions/checkout@v4
 
       - name: Install kerberos headers
-        run: sudo apt install libkrb5-dev
+        run: |
+          sudo apt-get update
+          sudo apt install libkrb5-dev
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -60,12 +50,6 @@ jobs:
       - name: Test with tox (no integration tests)
         run: tox -- -m "not integration"
 
-      - name: Upload coverage report
-        uses: codecov/codecov-action@v3
-        with:
-          fail_ci_if_error: true
-          token: ${{ secrets.CODECOV_TOKEN }}
-
   package:
     name: Build package
     runs-on: ubuntu-latest

.github/workflows/server_checks.yml

@@ -1,5 +1,13 @@
 on:
   workflow_call:
+    inputs:
+      skip-vm-management:
+        description: >
+          Whether to skip or not the start up of the virtual machine. Default
+          value is ``false``.
+        required: false
+        default: false
+        type: boolean
     secrets:
       AZURE_APP_ID:
         required: true
@@ -38,6 +46,7 @@ jobs:
       - name: Start VM with Azure CLI
         id: azure_cli
         uses: azure/CLI@v1
+        if: ${{ !(inputs.skip-vm-management)}}
         with:
           azcliversion: 2.32.0
           inlineScript: |
@@ -73,7 +82,9 @@ jobs:
 
       - name: Install kerberos headers (ubuntu only)
         if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: sudo apt install libkrb5-dev
+        run: |
+          sudo apt-get update
+          sudo apt install libkrb5-dev
 
       - name: Install dependencies
         run: pip install poetry 'tox<4' --disable-pip-version-check
@@ -141,7 +152,7 @@ jobs:
     name: Stop Azure VM
     runs-on: ubuntu-latest
     needs: docs
-    if: always()
+    if: ${{ always() && !(inputs.skip-vm-management)}}
 
     steps:
       - name: Stop Azure VM

.gitignore

@@ -52,8 +52,12 @@ test-output.xml
 # Docs builds
 doc/build
 
+.ipython/profile_default/history.sqlite
+
 # ipynb (generated from py files on docs build)
 *.ipynb
 
 # Pypi things
 deps
+
+venv/

.pre-commit-config.yaml

@@ -4,13 +4,13 @@ repos:
   rev: 23.7.0
   hooks:
   - id: black
+    exclude: ^examples/|doc/|.ipython/
 
-# ISORT should be activated at some point
-#
-# - repo: https://github.com/pycqa/isort
-#   rev: 5.10.1
-#   hooks:
-#   - id: isort
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
 
 - repo: https://github.com/PyCQA/flake8
   rev: 6.1.0
@@ -21,23 +21,25 @@ repos:
   rev: v2.2.5
   hooks:
   - id: codespell
+    args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt", "--skip", "poetry.lock"]
 
-# MYPY also not really working...
-# 
-# - repo: https://github.com/pre-commit/mirrors-mypy
-#   rev: v0.991  # Use the sha / tag you want to point at
-#   hooks:
-#   - id: mypy
-#     args: ["--config-file", "pyproject.toml", ./src/ ]
-
-# To be activated after quick dev cycles
-#
-# - repo: https://github.com/pycqa/pydocstyle
-#   rev: 6.1.1
-#   hooks:
-#   - id: pydocstyle
-#     additional_dependencies: [toml]
-#     exclude: "tests/"
+- repo: local
+  hooks:
+  - id: mypy-code
+    name: "mypy: checks on code"
+    entry: mypy
+    language: python
+    types: [python]
+    require_serial: true
+    files: "^(src/)"
+    additional_dependencies: ["mypy==1.5.1"]
+
+#- repo: https://github.com/pycqa/pydocstyle
+#  rev: 6.3.0
+#  hooks:
+#  - id: pydocstyle
+#    additional_dependencies: [tomli]
+#    files: "^(src/)"
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0

README.rst

@@ -1,15 +1,49 @@
+|pyansys| |python| |pypi| |GH-CI| |codecov| |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-grantami-bomanalytics?logo=pypi
+   :target: https://pypi.org/project/ansys-grantami-bomanalytics/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-grantami-bomanalytics.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-grantami-bomanalytics
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/grantami-bomanalytics/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/grantami-bomanalytics
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/grantami-bomanalytics/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/grantami-bomanalytics/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |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
+
+
 ansys-grantami-bomanalytics
 ###########################
 
 Project Overview
 ----------------
-PyGranta BoM Analytics is part of the larger `PyAnsys <https://github.com/pyansys>`_
+PyGranta BoM Analytics is part of the larger `PyAnsys <https://docs.pyansys.com>`_
 effort to facilitate the use of Ansys technologies directly from Python.
 
-The Granta MI Restricted Substances solution includes a REST API for
-evaluating compliance of products, assemblies, specifications, and
-materials against legislations. This package abstracts automatically-
-generated code into an easy-to-use client library.
+The MI Restricted Substances and MI Sustainability solutions for Granta MI include REST APIs for:
+
+ - Evaluating compliance of products, assemblies, specifications, and
+   materials against legislations.
+ - Evaluating the environmental performance of products, assemblies, materials and processes.
+
+This package abstracts automatically-generated code into an easy-to-use client library.
 
 
 Installation
@@ -24,7 +58,7 @@ Alternatively, clone and install this package with this code:
 
 .. code::
 
-   git clone https://github.com/pyansys/grantami-bomanalytics
+   git clone https://github.com/ansys/grantami-bomanalytics
    cd grantami-bomanalytics
    pip install .
 
@@ -49,7 +83,7 @@ Here's a brief example of how to use PyGranta BoM Analytics:
     >>> query = (
     ...     queries.MaterialImpactedSubstancesQuery()
     ...     .with_material_ids(['plastic-abs-pvc-flame'])
-    ...     .with_legislations(['EU REACH - The Candidate List'])
+    ...     .with_legislation_ids(['Candidate_AnnexXV'])
     ... )
 
     # Print out the result from the query.

cicd/check_server.py

@@ -1,10 +1,12 @@
-import requests
-from requests.auth import HTTPBasicAuth
-import os
-import json
-import time
 from functools import wraps
+import json
 import logging
+import os
+import platform
+import time
+
+import requests
+from requests.auth import HTTPBasicAuth
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger()
@@ -34,12 +36,25 @@ def wrapper(*args, **kwargs):
 
 @block_until_server_is_ok
 def check_status(url: str, auth_header: HTTPBasicAuth) -> bool:
+    python_implementation = platform.python_implementation()
+    python_version = platform.python_version()
+    os_version = platform.platform()
+    user_agent = f"check_server.py {python_implementation}/{python_version} ({os_version})"
+
     try:
-        response = requests.get(url + "/Health/v2.svc/", auth=auth_header)
-    except requests.exceptions.RequestException:
-        # This generally won't happen in normal operation. But if a RequestException happens we want to make sure we
-        # handle it and try again.
-        # If MI isn't running we'll generally get a 5xx status from the gateway instead, which is handled below.
+        response = requests.get(
+            url + "/Health/v2.svc/",
+            auth=auth_header,
+            headers={
+                "User-Agent": user_agent,
+            },
+        )
+    except requests.exceptions.RequestException as e:
+        # This generally won't happen in normal operation. But if a RequestException happens we want
+        # to make sure we handle it and try again.
+        # If MI isn't running we'll generally get a 5xx status from the gateway instead, which is
+        # handled below.
+        logger.error(e)
         return False
     logger.info(f"Received {response.status_code} response.")
     if response.status_code != 200: