feat: enabling structured package (#278)

Co-authored-by: German <28149841+germa89@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>

Author: 4 people

.flake8

@@ -1,6 +1,6 @@
 [flake8]
 exclude = venv, __init__.py, doc/_build, .venv
-select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
+select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E301, E303, E501, F401, F403
 count = True
 max-complexity = 10
 max-line-length = 100

.github/workflows/autodoc_cicd.yml

@@ -13,9 +13,9 @@ on:
 
 
 env:
-  RESET_PIP_CACHE_2: 0
-  RESET_AUTOSUMMARY_CACHE_2: 0
-  RESET_DOC_BUILD_CACHE_2: 0
+  RESET_PIP_CACHE_2: 1
+  RESET_AUTOSUMMARY_CACHE_2: 1
+  RESET_DOC_BUILD_CACHE_2: 1
 
 
 jobs:

.github/workflows/ci_cd.yml

@@ -18,9 +18,9 @@ env:
   PACKAGE_NAME: 'pyconverter-xml2py'
   PACKAGE_NAMESPACE: 'pyconverter.xml2py'
   DOCUMENTATION_CNAME: 'pyconverter-xml2py.docs.pyansys.com'
-  RESET_PIP_CACHE: 1
-  RESET_AUTOSUMMARY_CACHE: 1
-  RESET_DOC_BUILD_CACHE: 1
+  RESET_PIP_CACHE: 2
+  RESET_AUTOSUMMARY_CACHE: 2
+  RESET_DOC_BUILD_CACHE: 2
   ON_CI: true
 
 concurrency:

.gitignore

@@ -118,7 +118,7 @@ celerybeat.pid
 
 # Environments
 .env
-.venv
+.venv*
 env/
 venv/
 ENV/

_package/pyproject.toml

@@ -42,16 +42,16 @@ doc = [
     "numpydoc==1.8.0",
     "pandas==2.2.2",
     "parse==1.20.2",
+    "pydata_sphinx_theme==0.15.4",
     "pypandoc==1.13",
     "pytest-sphinx==0.6.3",
-    "pydata_sphinx_theme==0.15.4",
+    "pyyaml==6.0.1",
     "sphinx-autobuild==2024.4.16",
     "sphinx-autodoc-typehints==2.2.3",
     "sphinx-copybutton==0.5.2",
     "sphinx-notfound-page==1.0.4",
     "sphinx-gallery==0.17.1",
 ]
-
 [tool.flit.module]
 name = "pyconverter.generatedcommands"
 

config.yaml

@@ -0,0 +1,16 @@
+library_name_structured: # Future name of the library
+  - pyconverter
+  - generatedcommands
+
+new_package_name: package
+
+rules:
+  "/": slash
+  "*": star
+
+specific_command_mapping:
+  "*DEL": stardel
+  "C***": c
+
+specific_classes:
+  2D to 3D Analysis: Analysis 2D to 3D

make_package_doc.ps1

@@ -0,0 +1,20 @@
+#! /bin/sh
+
+function Green
+{
+    process { Write-Host $_ -ForegroundColor Green }
+}
+
+deactivate
+cd .\package\
+python -m venv .venv
+.\.venv\Scripts\activate
+ Write-Output "A new virtual environment has been created within the package folder." | Green
+pip install -e .[doc]
+ Write-Output "The package has successfully been installed in the virtual environment." | Green
+ Write-Output "The documentation is about to be built." | Green
+.\doc\make.bat html
+ Write-Output "The documentation has been successfully built." | Green
+.\doc\_build\html\index.html
+deactivate
+cd ..

pyproject.toml

@@ -34,7 +34,9 @@ dependencies = [
     "numpy>=1.14.0; python_version>='3.9'",
     "py-asciimath==0.3.0",
     "pylatexenc==2.10",
+    "pyyaml>=5.1.0",
     "tqdm>=4.64.1",
+    "regex>=2021.4.4",
 ]
 
 [project.optional-dependencies]
@@ -47,6 +49,8 @@ tests = [
     "pytest==8.3.2",
     "pytest-cov==5.0.0",
     "pytest-rerunfailures==14.0",
+    "pyyaml==6.0.1",
+    "regex==2024.5.15",
 ]
 doc = [
     "Sphinx==8.0.2",
@@ -60,6 +64,7 @@ doc = [
     "parse==1.20.2",
     "pypandoc==1.13",
     "pytest-sphinx==0.6.3",
+    "regex==2024.5.15",
     "sphinx-autobuild==2024.4.16",
     "sphinx-autodoc-typehints==2.2.2",
     "sphinx-copybutton==0.5.2",