Technical review

[RobPasMue]

Hi @mariostieriansys - after performing the technical review of this package I have found a few elements that need to be addressed. Listing them below. Feel free to reach out if you need any clarification:

• Main README image is broken
• What's the reason for having pyproject.toml, setup.py and setup.cfg? I believe that only the first one is needed because you are already providing your build information in it (as well as dev tools configuration). Can we get rid of the setup.* files?
• Missing ansys-pre-commit-hook for adding license headers. Since your repo is slightly different in terms of folders, you might have to adapt it according to https://pre-commit-hooks.docs.ansys.com/version/stable/#specify-directories-to-run-the-hook-on
• Run pre-commit autoupdate and bump the hook versions
• Adapt doc-style action to check in different locations than "doc" folder since it does not contain the repository's documentation. Due to the nested folders and extensions, I'd recommend putting it at root level of the repo (i.e. https://actions.docs.ansys.com/version/stable/style-actions/index.html#doc-style-action files: .
• Introduce dependabot
• Bump ansys/actions from v7 to v8
• Remove wheel release to PyPI - but keep the GitHub release step
• Remove https://github.com/ansys-internal/ansys-tools-omniverse/blob/main/src/ansys/tools/omniverse/VERSION and parse it from project's metadata. See https://github.com/ansys/pyensight/blob/e2d49557546cd92b77f4811607ccbdb39864f372/src/ansys/pyensight/core/__init__.py#L1-L5
• Adapt pyproject.toml metadata - Python versions supported is not true
• Revisit docstrings to follow proper numpydoc style - for example
  ** remove trailing colon
  https://github.com/ansys-internal/ansys-tools-omniverse/blob/f4c05f857e34e5fae53c4c02aae6f6145b24fea0/exts/ansys.tools.omniverse.core/ansys/tools/omniverse/core/extension.py#L81
  ** missing types
  https://github.com/ansys-internal/ansys-tools-omniverse/blob/f4c05f857e34e5fae53c4c02aae6f6145b24fea0/exts/ansys.tools.omniverse.core/ansys/tools/omniverse/core/extension.py#L243-L249

Other potential recommendations:

• RECOMMENDATION: Move https://github.com/ansys-internal/ansys-tools-omniverse/blob/main/rename_nightly_wheel.py to a dedicated scripts folder to avoid cluttering the root level of the repo

[RobPasMue]

Sorry... clicked enter to fast... Working on more edits

[RobPasMue]

Let's have this as a first round of changes @mariostieriansys - please let me know if you need help addressing them

[RobPasMue]

@mariostieriansys @randallfrank - some of the points were not addressed. Please adapt or add an explanation on why they will not be addressed. Thanks!

[mariostieriansys]

Hi @RobPasMue , sorry I was following your comments from the email, where I lost some of the points. I'll take care of them this morning

[RobPasMue]

Awesome, no problem at all! :)