Overall, the project looks great. The goal of this issue is to collect some minor tasks that need to be addressed before achieving a successful technical review. These tasks include:
[x] Include a tests/ directory
The project does not seem to have any unitary or regression tests. Tracked in #79.
[x] Add AUTHORS file
Addressed in #64
[x] Implement coverage metrics
Tracked in #79.
[x] Use Ruff for code sytle
Ruff collects most of the popular code linting and formatting tools under a common project. It is fast and reduces the amount of dependencies. The tool is compatible with pre-commit and can be configured through pyproject.toml. The .flake8 can be removed. Addresed in #51 & https://github.com/ansys/pyworkbench/pull/66 .
[x] #65
The landing file for the repository needs to be improved by including main labels, an About section, an Installation section, main Documentation links, Troubleshooting section, a License section, and a Changelog section. Addressed in #64
[x] Use Ansys pre-commit hooks
These ship a set of hooks, including the license headers. Addressed in #51.
[x] Gallery of examples
So far, there is only one example in the form of Jupyter Notebook. Ideally, the project should use a Python file, nbgallery, and Jupytext to generate the Examples section. Implemented in a dedicated repository, see https://examples.workbench.docs.pyansys.com
[x] Review pipelines for the project
Overall these look great. Some additional workflows could be added, for example, the ones for indexing the documentation. Maybe these could be added once the project is public. https://github.com/ansys/pyworkbench/pull/68
Overall, the project looks great. The goal of this issue is to collect some minor tasks that need to be addressed before achieving a successful technical review. These tasks include:
[x] Review ansys-api-workbench See https://github.com/ansys-internal/ansys-api-workbench. Completed in https://github.com/ansys-internal/ansys-api-workbench/pull/23
[x] Include a tests/ directory The project does not seem to have any unitary or regression tests. Tracked in #79.
[x] Add AUTHORS file
Addressed in #64
[x] Implement coverage metrics Tracked in #79.
[x] Use Ruff for code sytle Ruff collects most of the popular code linting and formatting tools under a common project. It is fast and reduces the amount of dependencies. The tool is compatible with
pre-commitand can be configured throughpyproject.toml. The.flake8can be removed. Addresed in #51 & https://github.com/ansys/pyworkbench/pull/66 .[x] #65 The landing file for the repository needs to be improved by including main labels, an
Aboutsection, anInstallationsection, mainDocumentationlinks,Troubleshootingsection, aLicensesection, and aChangelogsection. Addressed in #64[x] Use Ansys pre-commit hooks These ship a set of hooks, including the license headers. Addressed in #51.
[x] Gallery of examples So far, there is only one example in the form of Jupyter Notebook. Ideally, the project should use a Python file, nbgallery, and Jupytext to generate the Examples section. Implemented in a dedicated repository, see https://examples.workbench.docs.pyansys.com
[x] Overall documentation improvements Guarantee that slugs are right. Ensure no "index.rst" files exists apart from the landing one. Smart selection of slugs for SEO improvements. Note that documentation is using Markdown. Not a problem. This is tracked in https://github.com/ansys-internal/pyworkbench/pull/63 & https://github.com/ansys/pyworkbench/pull/63
[x] Review pipelines for the project Overall these look great. Some additional workflows could be added, for example, the ones for indexing the documentation. Maybe these could be added once the project is public. https://github.com/ansys/pyworkbench/pull/68