maint: technical review

[clatapie]

This pull-request performs the technical review of this project.

Changes by this PR:

• maint: .gitignore updated
• maint: pre-commit fixed
• maint: pyproject.toml modified
• maint: use flit instead of poetry as the building system
• README.rst file updated
• documentation updated
• CICD updated
• licensing headers added

To be done:

• documentation review # to be performed in another PR (related issue maint: documentation review #43)

[clatapie]

The pyansys-tools-variableinterop needs to be released first as it is a dependency of this package.

[phx-mkoninckx]

@clatapie : I'm not sure that increasing unit test coverage for this repo is a requirement we can meet. If you inspect the Python code in this repo in detail, you'll find that it is entirely abstract base classes -- there's no "executable" code here in some sense. The repo exists only to provide a place to store a common base for Python APIs of engineering workflow engines here at Ansys in general (i.e. a common base between ModelCenter and optiSLang). I'm not 100% certain of the function of the existing unit test or why it is named what it is but it seems to me that it achieves the goal of checking whether this module can be imported, which is really all that needs to happen to it. @phxnsharp may be able to provide more detail.

However, if there is a way that Ansys typically likes to test API-only python packages such as this one I'm sure we can implement that. Perhaps there's some information here I'm missing.

[phxnsharp]

I'm not 100% certain of the function of the existing unit test or why it is named what it is but it seems to me that it achieves the goal of checking whether this module can be imported, which is really all that needs to happen to it. @phxnsharp may be able to provide more detail.

I don't see the value in meeting some arbitrary code coverage target merely to mark off a checkbox. You are done testing when you have met the confidence level the business requires.

[clatapie]

Thank you for your feedback. As you asked, I removed the requirement for the 80% test coverage as this repository only contains classes and abstract methods.
The only remaining task is then the documentation review. For this topic, I am pinging @PipKat for visibility. Depending on what she prefers, we might create a new PR to perform it.

[clatapie]

The dependency error should be fixed once pyansys-tools-variableinterop will be released.

[PipKat]

Thank you for your feedback. As you asked, I removed the requirement for the 80% test coverage as this repository only contains classes and abstract methods. The only remaining task is then the documentation review. For this topic, I am pinging @PipKat for visibility. Depending on what she prefers, we might create a new PR to perform it.

@clatapie I would prefer to create a PR for the doc review. If you would please ping me when this PR is merged, I'll start a doc review. Also, I don't see a link in the right column to access the documentation for this repo. Would you add it there or at least send me the URL? Thanks.

[clatapie]

Thank you @PipKat, I will ping you once this PR will be merged.

[RobPasMue]

Overall LGTM!

[RobPasMue]

LGTM - nice job @clatapie