Changing package name into pyconverter-xml2py (#79)

Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Revathy Venugopal <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>

Author: 4 people

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 source =
-    pydita_ast
+    pyconverter.xml2py
 
 [report]
 show_missing = true

.github/workflows/autodoc_cicd.yml

@@ -35,27 +35,27 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: Python-pydita-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ hashFiles('pyproject.toml') }}
+          key: Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
-            Python-pydita-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}
+            Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}
       
       # The token will expire in 2024.
       - name: "Checkout mapdl-cmd-doc repository"
         uses: actions/checkout@v3
         with:
           repository: ansys-internal/mapdl-cmd-doc
-          ref: feat/pydita-ast-predifined-format
+          ref: feat/pyconverter-xml2py-predifined-format
           token: ${{ secrets.MAPDL_CMD_DOC_TOKEN }}
           path: mapdl-cmd-doc
 
-      - name: "Install pydita-ast"
+      - name: "Install pyconverter-xml2py"
         run: |
           pip install --upgrade pip
           pip install .[doc]
       
-      - name: "Create pydita-autogenerated doc"
+      - name: "Create pyconverter-autogenerated doc"
         run: |
-          pydita-ast package -x ${{ github.workspace }}/mapdl-cmd-doc -f ${{ github.workspace }}/tests/customized_functions
+          pyconverter-xml2py package -x ${{ github.workspace }}/mapdl-cmd-doc -f ${{ github.workspace }}/tests/customized_functions
       
       - name: Upload autogenerated doc artifacts
         uses: actions/upload-artifact@v3
@@ -98,34 +98,34 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: Python-pydita-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ inputs.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
+          key: Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ inputs.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
-            Python-pydita-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ inputs.MAIN_PYTHON_VERSION }}
+            Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ inputs.MAIN_PYTHON_VERSION }}
       
-      - name: "Install pydita-generatedcommands"
+      - name: "Install pyconverter-generatedcommands"
         run: |
           pip install .
       
-      - name: "Retrieve PyDita-Generatedcommands version"
+      - name: "Retrieve PyConverter-GeneratedCommands version"
         run: |
-          echo "PYDITA_GENERATED_VERSION=$(python -c 'from pydita.generatedcommands import __version__; print(__version__)')" >> $GITHUB_ENV
-          echo "PyDita-Generatedcommands version is: $(python -c 'from pydita.generatedcommands import __version__; print(__version__)')"
+          echo "PYCONVERTER_GENERATED_VERSION=$(python -c 'from pyconverter.generatedcommands import __version__; print(__version__)')" >> $GITHUB_ENV
+          echo "PyConverter-GeneratedCommands version is: $(python -c 'from pyconverter.generatedcommands import __version__; print(__version__)')"
 
       - name: "Cache docs build directory"
         uses: actions/cache@v3
         with:
           path: doc/_build
-          key: doc-build-pydita-generatedcommands-v${{ env.RESET_DOC_BUILD_CACHE_2 }}-${{ inputs.PYDITA_GENERATED_VERSION }}-${{ github.sha }}
+          key: doc-build-pyconverter-generatedcommands-v${{ env.RESET_DOC_BUILD_CACHE_2 }}-${{ inputs.PYCONVERTER_GENERATED_VERSION }}-${{ github.sha }}
           restore-keys: |
-            doc-build-pydita-generatedcommands-v${{ env.RESET_DOC_BUILD_CACHE_2 }}-${{ inputs.PYDITA_GENERATED_VERSION }}
+            doc-build-pyconverter-generatedcommands-v${{ env.RESET_DOC_BUILD_CACHE_2 }}-${{ inputs.PYCONVERTER_GENERATED_VERSION }}
 
       - name: "Cache autosummary"
         uses: actions/cache@v3
         with:
           path: doc/source/_autosummary/*.rst
-          key: autosummary-pydita-generatedcommands-v${{ env.RESET_AUTOSUMMARY_CACHE_2 }}-${{ inputs.PYDITA_GENERATED_VERSION }}-${{ github.sha }}
+          key: autosummary-pyconverter-generatedcommands-v${{ env.RESET_AUTOSUMMARY_CACHE_2 }}-${{ inputs.PYCONVERTER_GENERATED_VERSION }}-${{ github.sha }}
           restore-keys: |
-            autosummary-pydita-generatedcommands-v${{ env.RESET_AUTOSUMMARY_CACHE_2 }}-${{ inputs.PYDITA_GENERATED_VERSION }}
+            autosummary-pyconverter-generatedcommands-v${{ env.RESET_AUTOSUMMARY_CACHE_2 }}-${{ inputs.PYCONVERTER_GENERATED_VERSION }}
 
       - name: "Run Ansys documentation building action"
         uses: ansys/actions/doc-build@v4

.github/workflows/ci_cd.yml

@@ -15,9 +15,9 @@ on:
 
 env:
   MAIN_PYTHON_VERSION: '3.10'
-  PACKAGE_NAME: 'pydita-ast'
-  PACKAGE_NAMESPACE: 'pydita_ast'
-  DOCUMENTATION_CNAME: 'pydita-ast.docs.pyansys.com'
+  PACKAGE_NAME: 'pyconverter-xml2py'
+  PACKAGE_NAMESPACE: 'pyconverter.xml2py'
+  DOCUMENTATION_CNAME: 'pyconverter-xml2py.docs.pyansys.com'
   RESET_PIP_CACHE: 0
   RESET_AUTOSUMMARY_CACHE: 0
   RESET_DOC_BUILD_CACHE: 0
@@ -121,7 +121,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           repository: ansys-internal/mapdl-cmd-doc
-          ref: feat/pydita-ast-predifined-format
+          ref: feat/pyconverter-xml2py-predifined-format
           token: ${{ secrets.MAPDL_CMD_DOC_TOKEN }}
           path: mapdl-cmd-doc
 
@@ -133,7 +133,7 @@ jobs:
         run: |
           pytest -v --durations=10 --maxfail=10 \
             --reruns 7 --reruns-delay 3 --ghdir ${{ github.workspace }}\
-            --cov=pydita_ast --cov-report=xml:coverage.xml --cov-report=html\
+            --cov=pyconverter.xml2py --cov-report=xml:coverage.xml --cov-report=html\
             --cov-report term
 
       - name: "Upload coverage to Codecov"
@@ -166,35 +166,35 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: Python-pydita_ast-v${{ env.RESET_PIP_CACHE }}-${{ env.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
+          key: Python-pyconverter.xml2py-v${{ env.RESET_PIP_CACHE }}-${{ env.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
-            Python-pydita_ast-v${{ env.RESET_PIP_CACHE }}-${{ env.MAIN_PYTHON_VERSION }}
+            Python-pyconverter.xml2py-v${{ env.RESET_PIP_CACHE }}-${{ env.MAIN_PYTHON_VERSION }}
       
-      - name: "Install pydita-ast"
+      - name: "Install pyconverter-xml2py"
         run: |
           pip install --upgrade pip
           pip install .[doc]
       
-      - name: "Retrieve pydita_ast version"
+      - name: "Retrieve pyconverter.xml2py version"
         run: |
-          echo "PYDITA_VERSION=$(python -c 'from pydita_ast import __version__; print(__version__)')" >> $GITHUB_ENV
-          echo "pydita_ast version is: $(python -c 'from pydita_ast import __version__; print(__version__)')"
+          echo "PYCONVERTER_VERSION=$(python -c 'from pyconverter.xml2py import __version__; print(__version__)')" >> $GITHUB_ENV
+          echo "pyconverter.xml2py version is: $(python -c 'from pyconverter.xml2py import __version__; print(__version__)')"
     
       - name: "Cache docs build directory"
         uses: actions/cache@v3
         with:
           path: doc/_build
-          key: doc-build-pydita-ast-v${{ env.RESET_DOC_BUILD_CACHE }}-${{ env.PYDITA_VERSION }}-${{ github.sha }}
+          key: doc-build-pyconverter-xml2py-v${{ env.RESET_DOC_BUILD_CACHE }}-${{ env.PYCONVERTER_VERSION }}-${{ github.sha }}
           restore-keys: |
-            doc-build-pydita-ast-v${{ env.RESET_DOC_BUILD_CACHE }}-${{ env.PYDITA_VERSION }}
+            doc-build-pyconverter-xml2py-v${{ env.RESET_DOC_BUILD_CACHE }}-${{ env.PYCONVERTER_VERSION }}
 
       - name: "Cache autosummary"
         uses: actions/cache@v3
         with:
           path: doc/source/**/_autosummary/**/*.rst
-          key: autosummary-pydita-ast-v${{ env.RESET_AUTOSUMMARY_CACHE }}-${{ env.PYDITA_VERSION }}-${{ github.sha }}
+          key: autosummary-pyconverter-xml2py-v${{ env.RESET_AUTOSUMMARY_CACHE }}-${{ env.PYCONVERTER_VERSION }}-${{ github.sha }}
           restore-keys: |
-            autosummary-pydita-ast-v${{ env.RESET_AUTOSUMMARY_CACHE }}-${{ env.PYDITA_VERSION }}
+            autosummary-pyconverter-xml2py-v${{ env.RESET_AUTOSUMMARY_CACHE }}-${{ env.PYCONVERTER_VERSION }}
 
       - name: "Run Ansys documentation building action"
         uses: ansys/actions/doc-build@v4

.github/workflows/label.yml

@@ -79,9 +79,9 @@ jobs:
         issue-number: ${{ github.event.pull_request.number }}
         body: |
           Please add one of the following labels to add this contribution to the Release Notes :point_down:
-          - [bug](https://github.com/ansys/pydita-ast/pulls?q=label%3Abug+)
-          - [documentation](https://github.com/ansys/pydita-ast/pulls?q=label%3Adocumentation+)
-          - [enhancement](https://github.com/ansys/pydita-ast/pulls?q=label%3Aenhancement+)
-          - [good first issue](https://github.com/ansys/pydita-ast/pulls?q=label%3Agood+first+issue)
-          - [maintenance](https://github.com/ansys/pydita-ast/pulls?q=label%3Amaintenance+)
-          - [release](https://github.com/ansys/pydita-ast/pulls?q=label%3Arelease+)
+          - [bug](https://github.com/ansys/pyconverter-xml2py/pulls?q=label%3Abug+)
+          - [documentation](https://github.com/ansys/pyconverter-xml2py/pulls?q=label%3Adocumentation+)
+          - [enhancement](https://github.com/ansys/pyconverter-xml2py/pulls?q=label%3Aenhancement+)
+          - [good first issue](https://github.com/ansys/pyconverter-xml2py/pulls?q=label%3Agood+first+issue)
+          - [maintenance](https://github.com/ansys/pyconverter-xml2py/pulls?q=label%3Amaintenance+)
+          - [release](https://github.com/ansys/pyconverter-xml2py/pulls?q=label%3Arelease+)

README.rst

@@ -1,5 +1,5 @@
-PyDita-AST
-==========
+PyConverter-XML2Py
+==================
 
 A Python wrapper to convert XML documentation into Python source code
 with its related Sphinx documentation.
@@ -10,14 +10,14 @@ with its related Sphinx documentation.
    :target: https://docs.pyansys.com/
    :alt: PyAnsys
 
-.. |pypi| image:: https://img.shields.io/pypi/v/pydita-ast.svg?logo=python&logoColor=white
-   :target: https://pypi.org/project/pydita-ast/
+.. |pypi| image:: https://img.shields.io/pypi/v/pyconverter-xml2py.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/pyconverter-xml2py/
 
-.. |codecov| image:: https://codecov.io/gh/ansys/pydita-ast/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/ansys/pydita-ast
+.. |codecov| image:: https://codecov.io/gh/ansys/pyconverter-xml2py/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pyconverter-xml2py
 
-.. |GH-CI| image:: https://github.com/ansys/pydita-ast/actions/workflows/ci_cd.yml/badge.svg
-   :target: https://github.com/ansys/pydita-ast/actions/workflows/ci_cd.yml
+.. |GH-CI| image:: https://github.com/ansys/pyconverter-xml2py/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/pyconverter-xml2py/actions/workflows/ci_cd.yml
 
 .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
@@ -30,26 +30,26 @@ with its related Sphinx documentation.
 Overview
 --------
 
-The PyDita-AST project aims to automatically generate a Python library and a related 
+The PyConverter-XML2Py project aims to automatically generate a Python library and a related 
 Sphinx documentation from an XML documentation.
 
 
 Documentation and issues
 ------------------------
 
-On the `PyDita-AST Issues <https://github.com/ansys/pydita-ast/issues>`_ for this repository,
+On the `PyConverter-XML2Py Issues <https://github.com/ansys/pyconverter-xml2py/issues>`_ for this repository,
 you can create issues to submit questions, report bugs, and request new features. 
 To reach the PyAnsys support team, email `[email protected] <[email protected]>`_.
 
 
 Getting started
 ---------------
 
-Install the ``pydita-ast`` package with:
+Install the ``pyconverter-xml2py`` package with:
 
 .. code:: bash
 
-    python -m pip install pydita-ast
+    python -m pip install pyconverter-xml2py
 
 
 It is recommended to organize the XML documentation as follow:
@@ -66,14 +66,14 @@ Once the ``XML_directory`` is correctly organized, the converter can be run.
 
 .. code:: bash
 
-    pydita-ast package -x XML_directory_path
+    pyconverter-xml2py package -x XML_directory_path
 
 If some functions need to be customized, the path containing the python 
 files can be specified.
 
 .. code:: bash
 
-    pydita-ast package -x XML_directory_path -f customized_function_directory_path
+    pyconverter-xml2py package -x XML_directory_path -f customized_function_directory_path
 
 
 A new package is then automatically generated. Its default name is ``package``.

_package/doc/Makefile

@@ -25,4 +25,4 @@ clean:
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
-	(test -f $(BUILDDIR)/latex/pydita-generatedcommands-Documentation-*.pdf && echo pdf exists) || exit 1
+	(test -f $(BUILDDIR)/latex/pyconverter-generatedcommands-Documentation-*.pdf && echo pdf exists) || exit 1

_package/doc/source/conf.py

@@ -1,19 +1,19 @@
 from datetime import datetime
 
-from pydita.generatedcommands import __version__
+from pyconverter.generatedcommands import __version__
 
 # Project information
-project = "pydita-generatedcommands"
+project = "pyconverter-generatedcommands"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "ANSYS, Inc."
 release = version = __version__
 
-REPOSITORY_NAME = "pydita-generatedcommands"
+REPOSITORY_NAME = "pyconverter-generatedcommands"
 USERNAME = "pyansys"
 BRANCH = "main"
 
 # Options for HTML output
-html_short_title = html_title = "Documentation"
+html_short_title = html_title = "PyConverter-GeneratedCommands"
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
     "show_prev_next": False,

_package/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
-name = "pydita-generatedcommands"
+name = "pyconverter-generatedcommands"
 version = "0.1.dev0"
 description = "Documentation."
 readme = "README.rst"
@@ -53,12 +53,12 @@ doc = [
 ]
 
 [tool.flit.module]
-name = "pydita.generatedcommands"
+name = "pyconverter.generatedcommands"
 
 [project.urls]
-Source = "https://github.com/ansys/pydita-ast/"
-Tracker = "https://github.com/ansys/pydita-ast/issues"
-Homepage = "https://github.com/ansyspydita-ast"
+Source = "https://github.com/ansys/pyconverter-xml2py/"
+Tracker = "https://github.com/ansys/pyconverter-xml2py/issues"
+Homepage = "https://github.com/ansyspyconverter-xml2py"
 
 
 [tool.black]

doc/Makefile

@@ -25,4 +25,4 @@ clean:
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
-	(test -f $(BUILDDIR)/latex/pydita-ast-Documentation-*.pdf && echo pdf exists) || exit 1
+	(test -f $(BUILDDIR)/latex/pyconverter-xml2py-Documentation-*.pdf && echo pdf exists) || exit 1

doc/source/api/ast_class.rst

@@ -1,9 +1,14 @@
-AST tree
-========
+AST (abstract syntax tree)
+==========================
 
-.. currentmodule:: pydita_ast.ast_tree
+.. currentmodule:: pyconverter.xml2py.ast_tree
 
-The following classes are used to create the AST tree:
+An AST (Abstract Syntax Tree) is an abstract syntactic structure of text.
+Each node of the tree denotes a construct occurring in the XML file.
+Every element the AST contains can be edited using properties
+and functions to obtain the desired rendering.
+
+The following classes are used to create the AST:
 
 .. autosummary::
    :toctree: _autosummary/ast_class