From eaf0b5dd7c55261f2bc9ce9805907710ca3c3433 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Mon, 5 Aug 2024 14:21:11 +0200
Subject: [PATCH 01/35] maint: Tech review

---
 AUTHORS                                       | 12 ++++
 CODE_OF_CONDUCT.md                            | 65 +++++++++++++++++++
 CONTRIBUTORS.md                               |  5 ++
 app/__init__.py                               |  1 -
 docker/Dockerfile                             |  6 +-
 pyproject.toml                                | 43 ++++++++++++
 requirements.txt                              |  6 --
 src/allie/flowkit/__init__.py                 |  6 ++
 src/allie/flowkit/__main__.py                 | 13 ++++
 {app => src/allie/flowkit}/config/__init__.py |  2 +-
 {app => src/allie/flowkit}/config/_config.py  |  0
 .../allie/flowkit}/endpoints/__init__.py      |  0
 .../allie/flowkit}/endpoints/splitter.py      |  4 +-
 {app => src/allie/flowkit}/fastapi_utils.py   |  3 +-
 .../allie/flowkit/flowkit_service.py          | 16 ++---
 {app => src/allie/flowkit}/models/__init__.py |  0
 .../allie/flowkit}/models/functions.py        |  0
 {app => src/allie/flowkit}/models/splitter.py |  0
 18 files changed, 160 insertions(+), 22 deletions(-)
 create mode 100644 AUTHORS
 create mode 100644 CODE_OF_CONDUCT.md
 create mode 100644 CONTRIBUTORS.md
 delete mode 100644 app/__init__.py
 delete mode 100644 requirements.txt
 create mode 100644 src/allie/flowkit/__init__.py
 create mode 100644 src/allie/flowkit/__main__.py
 rename {app => src/allie/flowkit}/config/__init__.py (51%)
 rename {app => src/allie/flowkit}/config/_config.py (100%)
 rename {app => src/allie/flowkit}/endpoints/__init__.py (100%)
 rename {app => src/allie/flowkit}/endpoints/splitter.py (98%)
 rename {app => src/allie/flowkit}/fastapi_utils.py (98%)
 rename app/app.py => src/allie/flowkit/flowkit_service.py (64%)
 rename {app => src/allie/flowkit}/models/__init__.py (100%)
 rename {app => src/allie/flowkit}/models/functions.py (100%)
 rename {app => src/allie/flowkit}/models/splitter.py (100%)

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..600b719
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,12 @@
+# This is the list of ansys-tools-visualization-interface's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and wish to be added to this file
+# please submit a request.
+#
+#
+ANSYS, Inc.
\ No newline at end of file
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..5a9533d
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,65 @@
+# Contributor covenant code of conduct
+
+## Pledge
+
+In the interest of fostering an open and welcoming environment,
+all contributors and maintainers pledge to making participation
+in the Ansys project and community a harassment-free experience
+for everyone, regardless of age, body size, disability, ethnicity,
+sex characteristics, gender identity and expression, level of
+experience, education, socioeconomic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Standards
+
+Examples of behavior that contribute to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual
+  attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project email
+address, posting using an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Attribution
+
+This code of conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 0000000..209a3ad
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -0,0 +1,5 @@
+# Contributors
+
+## Project Lead or Owner
+
+* [Laura Sanchez-Gallego Kadri](https://github.com/laurasgkadri98)
diff --git a/app/__init__.py b/app/__init__.py
deleted file mode 100644
index dac4bb9..0000000
--- a/app/__init__.py
+++ /dev/null
@@ -1 +0,0 @@
-"""App package responsible for creating the FastAPI app."""
diff --git a/docker/Dockerfile b/docker/Dockerfile
index dd8dee9..28c9010 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -4,11 +4,11 @@ WORKDIR /app
 
 # Copy the app folder and the config.yaml file
 COPY requirements.txt .
-COPY app/ ./app/
+COPY app/ ./src/allie/flowkit/
 COPY configs/config.yaml .
 
 # Install dependencies
-RUN pip install --no-cache-dir -r requirements.txt
+RUN pip install --no-cache-dir .
 
 EXPOSE 8000
 
@@ -16,4 +16,4 @@ EXPOSE 8000
 ENV WORKERS=4
 
 # Use the environment variable in CMD
-CMD ["sh", "-c", "uvicorn app.app:app --host 0.0.0.0 --port 8000 --workers ${WORKERS}"]
\ No newline at end of file
+CMD ["sh", "-c", "allie-flowkit"]
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index d9fca73..29d328d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,3 +1,46 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "allie-flowkit"
+version = "0.1.dev0"
+description = ""
+readme = "README.md"
+requires-python = ">=3.10,<4"
+license = { file = "LICENSE" }
+authors = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }]
+maintainers = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "fastapi >= 0.111.1,<1",
+    "langchain >= 0.2.11,<1",
+    "pydantic >= 2.8.2,<3",
+    "pymupdf >= 1.24.9,<2",
+    "python_pptx >= 0.6.23,<1",
+    "PyYAML >= 6.0.1,<7",
+]
+
+[project.optional-dependencies]
+    all = [
+        "uvicorn[standard] >= 0.30.5,<1",
+    ]
+[project.scripts]
+allie-flowkit = "allie.flowkit.__main__:main"
+
+
+[tool.flit.module]
+name = "allie.flowkit"
+
 [tool.codespell]
 skip = "*.pyc,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac"
 
diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644
index ed213cf..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-fastapi==0.111.1
-langchain==0.2.11
-pydantic==2.8.2
-pymupdf==1.24.9
-python_pptx==0.6.23
-PyYAML==6.0.1
diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
new file mode 100644
index 0000000..2656bc8
--- /dev/null
+++ b/src/allie/flowkit/__init__.py
@@ -0,0 +1,6 @@
+"""App package responsible for creating the FastAPI app."""
+import importlib.metadata as importlib_metadata
+
+__version__ = importlib_metadata.version(__name__.replace(".", "-"))
+
+from allie.flowkit.flowkit_service import flowkit_service
\ No newline at end of file
diff --git a/src/allie/flowkit/__main__.py b/src/allie/flowkit/__main__.py
new file mode 100644
index 0000000..dca1561
--- /dev/null
+++ b/src/allie/flowkit/__main__.py
@@ -0,0 +1,13 @@
+try:
+    import uvicorn
+except ImportError:
+    raise ImportError("Please install uvicorn to run the service: pip install allie-flowkit-python[all]")
+
+from allie.flowkit.flowkit_service import flowkit_service
+
+
+def main():
+    uvicorn.run("allie.flowkit:flowkit_service", host="0.0.0.0", port=8000, workers=4)
+
+if __name__ == "__main__":
+    main()
\ No newline at end of file
diff --git a/app/config/__init__.py b/src/allie/flowkit/config/__init__.py
similarity index 51%
rename from app/config/__init__.py
rename to src/allie/flowkit/config/__init__.py
index b459b87..acf3ab2 100644
--- a/app/config/__init__.py
+++ b/src/allie/flowkit/config/__init__.py
@@ -1,3 +1,3 @@
 """Configuration package for the application."""
 
-from app.config._config import CONFIG
+from allie.flowkit.config._config import CONFIG
diff --git a/app/config/_config.py b/src/allie/flowkit/config/_config.py
similarity index 100%
rename from app/config/_config.py
rename to src/allie/flowkit/config/_config.py
diff --git a/app/endpoints/__init__.py b/src/allie/flowkit/endpoints/__init__.py
similarity index 100%
rename from app/endpoints/__init__.py
rename to src/allie/flowkit/endpoints/__init__.py
diff --git a/app/endpoints/splitter.py b/src/allie/flowkit/endpoints/splitter.py
similarity index 98%
rename from app/endpoints/splitter.py
rename to src/allie/flowkit/endpoints/splitter.py
index d5f8ef3..2295022 100644
--- a/app/endpoints/splitter.py
+++ b/src/allie/flowkit/endpoints/splitter.py
@@ -1,8 +1,8 @@
 import base64
 import io
 
-from app.config._config import CONFIG
-from app.models.splitter import SplitterRequest, SplitterResponse
+from allie.flowkit.config._config import CONFIG
+from allie.flowkit.models.splitter import SplitterRequest, SplitterResponse
 from fastapi import APIRouter, Header, HTTPException
 from langchain.text_splitter import PythonCodeTextSplitter, RecursiveCharacterTextSplitter
 from pptx import Presentation
diff --git a/app/fastapi_utils.py b/src/allie/flowkit/fastapi_utils.py
similarity index 98%
rename from app/fastapi_utils.py
rename to src/allie/flowkit/fastapi_utils.py
index b700084..6098e86 100644
--- a/app/fastapi_utils.py
+++ b/src/allie/flowkit/fastapi_utils.py
@@ -1,10 +1,11 @@
 import inspect
 from typing import Any, Dict, List, Type, get_type_hints
 
-from app.models.functions import EndpointInfo, ParameterInfo
 from fastapi.routing import APIRoute
 from pydantic import BaseModel
 
+from allie.flowkit.models.functions import EndpointInfo, ParameterInfo
+
 
 def extract_field_type(field_info: dict):
     """Extract the field type from a given schema field information.
diff --git a/app/app.py b/src/allie/flowkit/flowkit_service.py
similarity index 64%
rename from app/app.py
rename to src/allie/flowkit/flowkit_service.py
index 7578e6a..420d949 100644
--- a/app/app.py
+++ b/src/allie/flowkit/flowkit_service.py
@@ -1,15 +1,15 @@
 from typing import List
 
-from app.config._config import CONFIG
-from app.endpoints import splitter
-from app.fastapi_utils import extract_endpoint_info
-from app.models.functions import EndpointInfo
+from allie.flowkit.config._config import CONFIG
+from allie.flowkit.endpoints import splitter
+from allie.flowkit.fastapi_utils import extract_endpoint_info
+from allie.flowkit.models.functions import EndpointInfo
 from fastapi import FastAPI, Header, HTTPException
 
-app = FastAPI()
+flowkit_service = FastAPI()
 
 # Include routers from all endpoints
-app.include_router(splitter.router, prefix="/splitter", tags=["splitter"])
+flowkit_service.include_router(splitter.router, prefix="/splitter", tags=["splitter"])
 
 # Map of function names to function objects
 function_map = {
@@ -20,7 +20,7 @@
 
 
 # Endpoint to list all enpoint information
-@app.get("/", response_model=List[EndpointInfo])
+@flowkit_service.get("/", response_model=List[EndpointInfo])
 async def list_functions(api_key: str = Header(...)) -> List[EndpointInfo]:
     """List all available functions and their endpoints.
 
@@ -39,4 +39,4 @@ async def list_functions(api_key: str = Header(...)) -> List[EndpointInfo]:
     if api_key != CONFIG.flowkit_python_api_key:
         raise HTTPException(status_code=401, detail="Invalid API key")
 
-    return extract_endpoint_info(function_map, app.routes)
+    return extract_endpoint_info(function_map, flowkit_service.routes)
diff --git a/app/models/__init__.py b/src/allie/flowkit/models/__init__.py
similarity index 100%
rename from app/models/__init__.py
rename to src/allie/flowkit/models/__init__.py
diff --git a/app/models/functions.py b/src/allie/flowkit/models/functions.py
similarity index 100%
rename from app/models/functions.py
rename to src/allie/flowkit/models/functions.py
diff --git a/app/models/splitter.py b/src/allie/flowkit/models/splitter.py
similarity index 100%
rename from app/models/splitter.py
rename to src/allie/flowkit/models/splitter.py

From 35a55b308644e1b74cbe5a90dea97e2978ee0d69 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 09:31:32 +0200
Subject: [PATCH 02/35] fix: Several changes

---
 src/allie/flowkit/__init__.py           |  2 +-
 src/allie/flowkit/__main__.py           | 11 +++++++----
 src/allie/flowkit/config/_config.py     |  1 +
 src/allie/flowkit/endpoints/splitter.py |  6 ++++--
 src/allie/flowkit/fastapi_utils.py      |  7 ++++---
 src/allie/flowkit/flowkit_service.py    |  4 +++-
 src/allie/flowkit/models/functions.py   |  1 +
 src/allie/flowkit/models/splitter.py    |  1 +
 8 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
index 2656bc8..91a864a 100644
--- a/src/allie/flowkit/__init__.py
+++ b/src/allie/flowkit/__init__.py
@@ -3,4 +3,4 @@
 
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 
-from allie.flowkit.flowkit_service import flowkit_service
\ No newline at end of file
+from allie.flowkit.flowkit_service import flowkit_service
diff --git a/src/allie/flowkit/__main__.py b/src/allie/flowkit/__main__.py
index dca1561..b5366e0 100644
--- a/src/allie/flowkit/__main__.py
+++ b/src/allie/flowkit/__main__.py
@@ -1,13 +1,16 @@
+"""Main module for the FlowKit service."""
 try:
     import uvicorn
 except ImportError:
-    raise ImportError("Please install uvicorn to run the service: pip install allie-flowkit-python[all]")
-
-from allie.flowkit.flowkit_service import flowkit_service
+    raise ImportError(
+        "Please install uvicorn to run the service: pip install allie-flowkit-python[all]"
+    )
 
 
 def main():
+    """Run entrypoint for the FlowKit service."""
     uvicorn.run("allie.flowkit:flowkit_service", host="0.0.0.0", port=8000, workers=4)
 
+
 if __name__ == "__main__":
-    main()
\ No newline at end of file
+    main()
diff --git a/src/allie/flowkit/config/_config.py b/src/allie/flowkit/config/_config.py
index f7a1c35..804ab5c 100644
--- a/src/allie/flowkit/config/_config.py
+++ b/src/allie/flowkit/config/_config.py
@@ -1,3 +1,4 @@
+"""Module for reading the configuration settings from a YAML file."""
 import os
 
 import yaml
diff --git a/src/allie/flowkit/endpoints/splitter.py b/src/allie/flowkit/endpoints/splitter.py
index 2295022..0063793 100644
--- a/src/allie/flowkit/endpoints/splitter.py
+++ b/src/allie/flowkit/endpoints/splitter.py
@@ -1,13 +1,15 @@
+"""Module for splitting text into chunks."""
 import base64
 import io
 
-from allie.flowkit.config._config import CONFIG
-from allie.flowkit.models.splitter import SplitterRequest, SplitterResponse
 from fastapi import APIRouter, Header, HTTPException
 from langchain.text_splitter import PythonCodeTextSplitter, RecursiveCharacterTextSplitter
 from pptx import Presentation
 import pymupdf
 
+from allie.flowkit.config._config import CONFIG
+from allie.flowkit.models.splitter import SplitterRequest, SplitterResponse
+
 router = APIRouter()
 
 
diff --git a/src/allie/flowkit/fastapi_utils.py b/src/allie/flowkit/fastapi_utils.py
index 6098e86..03a73e5 100644
--- a/src/allie/flowkit/fastapi_utils.py
+++ b/src/allie/flowkit/fastapi_utils.py
@@ -1,3 +1,4 @@
+"""Utils module for FastAPI related operations."""
 import inspect
 from typing import Any, Dict, List, Type, get_type_hints
 
@@ -56,7 +57,7 @@ def extract_fields_from_schema(schema: dict):
     return fields
 
 
-def get_parameters_info(params):
+def get_parameters_info(params: dict):
     """Get parameter information from function parameters.
 
     Parameters
@@ -175,9 +176,9 @@ def extract_endpoint_info(
 
     Parameters
     ----------
-    function_map : dict
+    function_map : Dict[str, Any]
         A dictionary mapping function names to their implementations.
-    routes : list
+    routes : List[APIRoute]
         A list of APIRoute objects representing the API routes.
 
     Returns
diff --git a/src/allie/flowkit/flowkit_service.py b/src/allie/flowkit/flowkit_service.py
index 420d949..1bc7e3f 100644
--- a/src/allie/flowkit/flowkit_service.py
+++ b/src/allie/flowkit/flowkit_service.py
@@ -1,10 +1,12 @@
+"""Module for the Allie Flowkit service."""
 from typing import List
 
+from fastapi import FastAPI, Header, HTTPException
+
 from allie.flowkit.config._config import CONFIG
 from allie.flowkit.endpoints import splitter
 from allie.flowkit.fastapi_utils import extract_endpoint_info
 from allie.flowkit.models.functions import EndpointInfo
-from fastapi import FastAPI, Header, HTTPException
 
 flowkit_service = FastAPI()
 
diff --git a/src/allie/flowkit/models/functions.py b/src/allie/flowkit/models/functions.py
index ba8415a..4cb439a 100644
--- a/src/allie/flowkit/models/functions.py
+++ b/src/allie/flowkit/models/functions.py
@@ -1,3 +1,4 @@
+"""Module for defining the models used in the endpoints."""
 from typing import Any, Dict, List
 
 from pydantic import BaseModel
diff --git a/src/allie/flowkit/models/splitter.py b/src/allie/flowkit/models/splitter.py
index 1ee4bb5..dc019fc 100644
--- a/src/allie/flowkit/models/splitter.py
+++ b/src/allie/flowkit/models/splitter.py
@@ -1,3 +1,4 @@
+"""Model for the splitter endpoint."""
 from typing import List
 
 from pydantic import BaseModel

From 671eebb679f87de25adac308c8b94a3fa53eff74 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 09:40:47 +0200
Subject: [PATCH 03/35] feat: Use ruff in pre-commit

---
 .pre-commit-config.yaml                 | 42 ++++++++++++-------------
 pyproject.toml                          | 29 +++++++++++++++++
 src/allie/flowkit/__init__.py           |  2 +-
 src/allie/flowkit/config/__init__.py    |  2 +-
 src/allie/flowkit/config/_config.py     |  6 ++--
 src/allie/flowkit/endpoints/splitter.py |  5 ++-
 src/allie/flowkit/fastapi_utils.py      |  5 ++-
 src/allie/flowkit/flowkit_service.py    |  3 +-
 8 files changed, 60 insertions(+), 34 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 9e58958..cc07e30 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,26 +1,9 @@
 repos:
-- repo: https://github.com/psf/black
-  rev: 23.12.1
+- repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.18.0
   hooks:
-  - id: black
-
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 6.1.0
-  hooks:
-  - id: flake8
-
-- repo: https://github.com/pycqa/pydocstyle
-  rev: 6.3.0
-  hooks:
-  - id: pydocstyle
-    args: ["--ignore=D205,D100,D213,D203"]
-    exclude: examples
-    additional_dependencies: [toml]
+  - id: blacken-docs
+    additional_dependencies: [black==23.12.1]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.5.0
@@ -30,7 +13,22 @@ repos:
   - id: check-yaml
   - id: trailing-whitespace
 
+#- repo: https://github.com/ansys/pre-commit-hooks
+#  rev: v0.3.1
+#  hooks:
+#    - id: add-license-headers
+#      files: '(src|examples|tests|docker)/.*\.(py)|\.(proto)'
+#      args:
+#      - --start_year=2024
+
 - repo: https://github.com/python-jsonschema/check-jsonschema
   rev: 0.27.3
   hooks:
-    - id: check-github-workflows
\ No newline at end of file
+    - id: check-github-workflows
+
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.5.5
+  hooks:
+    - id: ruff
+      args: [--fix]
diff --git a/pyproject.toml b/pyproject.toml
index 29d328d..26c4ae6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -60,3 +60,32 @@ convention = "numpy"
 [tool.mypy]
 strict = true
 ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 120
+extend-exclude = ["examples/**/*.py"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle, see https://beta.ruff.rs/docs/rules/#pycodestyle-e-w
+    "D",   # pydocstyle, see https://beta.ruff.rs/docs/rules/#pydocstyle-d
+    "F",   # pyflakes, see https://beta.ruff.rs/docs/rules/#pyflakes-f
+    "I",   # isort, see https://beta.ruff.rs/docs/rules/#isort-i
+    "N",   # pep8-naming, see https://beta.ruff.rs/docs/rules/#pep8-naming-n
+    "PTH", # flake8-use-pathlib, https://beta.ruff.rs/docs/rules/#flake8-use-pathlib-pth
+]
+ignore = ["D416"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "tab"
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true
+known-first-party = ["ansys"]
+
+[tool.ruff.lint.pydocstyle]
+# Settings: https://docs.astral.sh/ruff/settings/#lintpydocstyle
+convention = "google"
\ No newline at end of file
diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
index 91a864a..8e2f692 100644
--- a/src/allie/flowkit/__init__.py
+++ b/src/allie/flowkit/__init__.py
@@ -3,4 +3,4 @@
 
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 
-from allie.flowkit.flowkit_service import flowkit_service
+from allie.flowkit.flowkit_service import flowkit_service  # noqa F401
diff --git a/src/allie/flowkit/config/__init__.py b/src/allie/flowkit/config/__init__.py
index acf3ab2..c1cdd83 100644
--- a/src/allie/flowkit/config/__init__.py
+++ b/src/allie/flowkit/config/__init__.py
@@ -1,3 +1,3 @@
 """Configuration package for the application."""
 
-from allie.flowkit.config._config import CONFIG
+from allie.flowkit.config._config import CONFIG # noqa F401
diff --git a/src/allie/flowkit/config/_config.py b/src/allie/flowkit/config/_config.py
index 804ab5c..6afe67d 100644
--- a/src/allie/flowkit/config/_config.py
+++ b/src/allie/flowkit/config/_config.py
@@ -1,5 +1,6 @@
 """Module for reading the configuration settings from a YAML file."""
 import os
+from pathlib import Path
 
 import yaml
 
@@ -22,6 +23,7 @@ class Config:
 
     def __init__(self):
         """Initialize the Config object by reading the configuration file.
+
         Also, check if the 'FLOWKIT_PYTHON_API_KEY' is present in the
         configuration file.
 
@@ -59,12 +61,12 @@ def _load_config(self, config_path: str) -> dict:
 
         """
         try:
-            with open(config_path, "r") as file:
+            with Path(config_path).open("r") as file:
                 return yaml.safe_load(file)
         except FileNotFoundError:
             print(f"Configuration file not found at: {config_path}, using default location.")
             try:
-                with open("configs/config.yaml", "r") as file:
+                with Path("configs/config.yaml").open("r") as file:
                     return yaml.safe_load(file)
             except FileNotFoundError:
                 raise FileNotFoundError("Configuration file not found at the default location.")
diff --git a/src/allie/flowkit/endpoints/splitter.py b/src/allie/flowkit/endpoints/splitter.py
index 0063793..ad75b55 100644
--- a/src/allie/flowkit/endpoints/splitter.py
+++ b/src/allie/flowkit/endpoints/splitter.py
@@ -2,14 +2,13 @@
 import base64
 import io
 
+from allie.flowkit.config._config import CONFIG
+from allie.flowkit.models.splitter import SplitterRequest, SplitterResponse
 from fastapi import APIRouter, Header, HTTPException
 from langchain.text_splitter import PythonCodeTextSplitter, RecursiveCharacterTextSplitter
 from pptx import Presentation
 import pymupdf
 
-from allie.flowkit.config._config import CONFIG
-from allie.flowkit.models.splitter import SplitterRequest, SplitterResponse
-
 router = APIRouter()
 
 
diff --git a/src/allie/flowkit/fastapi_utils.py b/src/allie/flowkit/fastapi_utils.py
index 03a73e5..c3ccacc 100644
--- a/src/allie/flowkit/fastapi_utils.py
+++ b/src/allie/flowkit/fastapi_utils.py
@@ -2,11 +2,10 @@
 import inspect
 from typing import Any, Dict, List, Type, get_type_hints
 
+from allie.flowkit.models.functions import EndpointInfo, ParameterInfo
 from fastapi.routing import APIRoute
 from pydantic import BaseModel
 
-from allie.flowkit.models.functions import EndpointInfo, ParameterInfo
-
 
 def extract_field_type(field_info: dict):
     """Extract the field type from a given schema field information.
@@ -76,7 +75,7 @@ def get_parameters_info(params: dict):
         # If the param is a header skip it
         if "alias" in str(param.default) and "annotation" in str(param.default):
             continue
-        if param.annotation == bytes:
+        if isinstance(param.annotation, bytes):
             param_info = ParameterInfo(name=param.name, type="bytes")
             parameters_info.append(param_info)
         elif hasattr(param.annotation, "schema"):
diff --git a/src/allie/flowkit/flowkit_service.py b/src/allie/flowkit/flowkit_service.py
index 1bc7e3f..d0875e9 100644
--- a/src/allie/flowkit/flowkit_service.py
+++ b/src/allie/flowkit/flowkit_service.py
@@ -1,12 +1,11 @@
 """Module for the Allie Flowkit service."""
 from typing import List
 
-from fastapi import FastAPI, Header, HTTPException
-
 from allie.flowkit.config._config import CONFIG
 from allie.flowkit.endpoints import splitter
 from allie.flowkit.fastapi_utils import extract_endpoint_info
 from allie.flowkit.models.functions import EndpointInfo
+from fastapi import FastAPI, Header, HTTPException
 
 flowkit_service = FastAPI()
 

From 98436a3dc8ba96794902072ff06fdc42d8f0dadf Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 09:44:08 +0200
Subject: [PATCH 04/35] feat: Add contributing guide

---
 CONTRIBUTING.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..63c2749
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,76 @@
+# Contribute
+
+Overall guidance on contributing to a PyAnsys library appears in the
+[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
+are thoroughly familiar with this guide before attempting to contribute to
+allie-flowkit-python.
+
+The following contribution information is specific to *Allie Flowkit Python*.
+
+[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
+
+## Clone the repository
+
+To clone and install the latest *Allie Flowkit Python* release in development mode, run
+these commands:
+
+```bash
+git clone https://github.com/ansys/allie-flowkit-python/
+cd allie-flowkit-python
+python -m pip install --upgrade pip
+pip install -e .
+```
+
+## Adhere to code style
+
+*Allie Flowkit Python* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
+
+To ensure your code meets minimum code styling standards, run these commands:
+
+```bash
+pip install pre-commit
+pre-commit run --all-files
+```
+
+You can also install this as a pre-commit hook by running this command:
+
+```bash
+pre-commit install
+```
+
+## Run the tests
+
+Prior to running the tests, you must run this command to install the test dependencies:
+
+```bash
+pip install -e .[tests]
+```
+
+To run the tests, navigate to the root directory of the repository and run this command:
+
+```bash
+pytest
+```
+
+
+## Build the documentation
+
+Prior to building the documentation, you must run this command to install the documentation dependencies:
+
+```bash
+pip install -e .[doc]
+```
+
+To build the documentation, run the following commands:
+
+```bash
+cd doc
+
+# On linux
+make html
+
+# On windows
+./make.bat html
+```
+
+The documentation is built in the `docs/_build/html` directory.

From 965b643120447568cb3e344569f179ee24d4a62c Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 09:59:59 +0200
Subject: [PATCH 05/35] fix: Add argparse and update readme

---
 README.md                     |  6 +++---
 pyproject.toml                | 13 ++++++++++---
 src/allie/flowkit/__main__.py |  8 +++++++-
 3 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index dd89532..b03b011 100644
--- a/README.md
+++ b/README.md
@@ -59,16 +59,16 @@ Allie FlowKit Python can be run locally or as a Docker container. Follow the ins
     cd allie-flowkit-python
     ```
 
-2. Install the required dependencies:
+2. Install the project:
     ```sh
-    pip install -r requirements.txt
+    pip install .
     ```
 
 #### Usage
 
 1. Start the service:
     ```sh
-    uvicorn app.app:app --host 0.0.0.0 --port 50052 --workers 1
+    allie-flowkit --host 0.0.0.0 --port 50052 --workers 1
     ```
     You can specify the host, port, and number of workers as needed.
 
diff --git a/pyproject.toml b/pyproject.toml
index 26c4ae6..9297c03 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -31,9 +31,16 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-    all = [
-        "uvicorn[standard] >= 0.30.5,<1",
-    ]
+all = [
+    "uvicorn[standard] >= 0.30.5,<1",
+]
+
+[project.urls]
+Source = "https://github.com/ansys/allie-flowkit-python"
+Issues = "https://github.com/ansys/allie-flowkit-python/issues"
+Discussions = "https://github.com/ansys/allie-flowkit-python/discussions"
+Releases = "https://github.com/ansys/allie-flowkit-python/releases/"
+
 [project.scripts]
 allie-flowkit = "allie.flowkit.__main__:main"
 
diff --git a/src/allie/flowkit/__main__.py b/src/allie/flowkit/__main__.py
index b5366e0..71f3771 100644
--- a/src/allie/flowkit/__main__.py
+++ b/src/allie/flowkit/__main__.py
@@ -5,11 +5,17 @@
     raise ImportError(
         "Please install uvicorn to run the service: pip install allie-flowkit-python[all]"
     )
+import argparse
 
 
 def main():
     """Run entrypoint for the FlowKit service."""
-    uvicorn.run("allie.flowkit:flowkit_service", host="0.0.0.0", port=8000, workers=4)
+    parse  = argparse.ArgumentParser()
+    parse.add_argument("--host", type=str, default="0.0.0.0", help="The host to run the service on. By default 0.0.0.0")
+    parse.add_argument("--port", type=int, default=8000, help="The port to run the service on. By default 8000")
+    parse.add_argument("--workers", type=int, default=4, help="The number of workers to use. By default 4")
+    args = parse.parse_args()
+    uvicorn.run("allie.flowkit:flowkit_service", host=args.host, port=args.port, workers=args.workers)
 
 
 if __name__ == "__main__":

From 3cb10f33c1ab5b81b42d06e5ebd21c2504f5d03d Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:05:00 +0200
Subject: [PATCH 06/35] fix: Rename

---
 README.md      | 2 +-
 pyproject.toml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b03b011..1ad9973 100644
--- a/README.md
+++ b/README.md
@@ -68,7 +68,7 @@ Allie FlowKit Python can be run locally or as a Docker container. Follow the ins
 
 1. Start the service:
     ```sh
-    allie-flowkit --host 0.0.0.0 --port 50052 --workers 1
+    allie-flowkit-python --host 0.0.0.0 --port 50052 --workers 1
     ```
     You can specify the host, port, and number of workers as needed.
 
diff --git a/pyproject.toml b/pyproject.toml
index 9297c03..c0e42d7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -42,7 +42,7 @@ Discussions = "https://github.com/ansys/allie-flowkit-python/discussions"
 Releases = "https://github.com/ansys/allie-flowkit-python/releases/"
 
 [project.scripts]
-allie-flowkit = "allie.flowkit.__main__:main"
+allie-flowkit-python = "allie.flowkit.__main__:main"
 
 
 [tool.flit.module]

From cc13384dc43c823602e43ab9e965e7cbfdda0c6e Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:07:12 +0200
Subject: [PATCH 07/35] maint: Add labeler

---
 .github/labeler.yml | 11 +++++++++++
 .github/labels.yml  | 44 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+)
 create mode 100644 .github/labeler.yml
 create mode 100644 .github/labels.yml

diff --git a/.github/labeler.yml b/.github/labeler.yml
new file mode 100644
index 0000000..c026167
--- /dev/null
+++ b/.github/labeler.yml
@@ -0,0 +1,11 @@
+documentation:
+- changed-files:
+  - any-glob-to-any-file: ['doc/source/**/*', 'README.md']
+
+maintenance:
+- changed-files:
+  - any-glob-to-any-file: ['.github/**/*', 'pyproject.toml', 'tox.ini', '.pre-commit-config.yaml']
+
+testing:
+- changed-files:
+  - any-glob-to-any-file: ['tests/*']
diff --git a/.github/labels.yml b/.github/labels.yml
new file mode 100644
index 0000000..b24d889
--- /dev/null
+++ b/.github/labels.yml
@@ -0,0 +1,44 @@
+- name: bug
+  description: Something isn't working
+  color: d42a34
+
+- name: dependencies
+  description: Related with project dependencies
+  color: ffc0cb
+
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0677ba
+
+- name: enhancement
+  description: New features or code improvements
+  color: FFD827
+
+- name: good first issue
+  description: Easy to solve for newcomers
+  color: 62ca50
+
+- name: maintenance
+  description: Package and maintenance related
+  color: f78c37
+
+- name: release
+  description: Anything related to an incoming release
+  color: ffffff
+
+- name: testing
+  description: Anything related to testing
+  color: 5802B8
+
+- name: graphics
+  description: Anything related to graphics
+  color: 5903A8
+
+- name: triage
+  description: Need some assessment
+  color: f78a50
+
+- name: top priority
+  description: Must be fixed promptly
+  color: ab8a50
+

From c3a506d02b86b0442836de19afb74a707ff452de Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:09:42 +0200
Subject: [PATCH 08/35] maint: Add smoke tests

---
 .github/workflows/ci_cd.yml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index ff6d28a..d04afe8 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -26,6 +26,27 @@ jobs:
       - name: "Run PyAnsys code style checks"
         uses: ansys/actions/code-style@v6
 
+  smoke-tests:
+    name: Build and Smoke tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.10', '3.11', '3.12']
+        should-release:
+          - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
+        exclude:
+          - should-release: false
+            os: macos-latest
+    steps:
+      - name: Build wheelhouse and perform smoke test
+        uses: ansys/actions/build-wheelhouse@v6
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python-version }}
+
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')

From 60e57cf4401ac862e09c68b891457a561889ee02 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:50:22 +0200
Subject: [PATCH 09/35] doc: Add docs

---
 .gitignore                           |   6 +-
 AUTHORS                              |   2 +-
 doc/ANSYS/accept.txt                 |   2 +
 doc/ANSYS/reject.txt                 |   0
 doc/Makefile                         |  38 +++++
 doc/make.bat                         |  64 +++++++
 doc/source/conf.py                   | 241 +++++++++++++++++++++++++++
 doc/source/contributing.rst          |  11 ++
 doc/source/examples/index.rst        |   7 +
 doc/source/getting_started/index.rst |  39 +++++
 doc/source/index.rst                 |  77 +++++++++
 doc/source/user_guide/index.rst      |   9 +
 pyproject.toml                       |  13 ++
 src/allie/flowkit/config/_config.py  |   7 +-
 14 files changed, 512 insertions(+), 4 deletions(-)
 create mode 100644 doc/ANSYS/accept.txt
 create mode 100644 doc/ANSYS/reject.txt
 create mode 100644 doc/Makefile
 create mode 100644 doc/make.bat
 create mode 100644 doc/source/conf.py
 create mode 100644 doc/source/contributing.rst
 create mode 100644 doc/source/examples/index.rst
 create mode 100644 doc/source/getting_started/index.rst
 create mode 100644 doc/source/index.rst
 create mode 100644 doc/source/user_guide/index.rst

diff --git a/.gitignore b/.gitignore
index abaf5ac..9641641 100644
--- a/.gitignore
+++ b/.gitignore
@@ -40,4 +40,8 @@ dist/
 config.yaml
 
 # Do not ignore config.yaml in the configs/ directory
-!configs/config.yaml
\ No newline at end of file
+!configs/config.yaml
+
+# Docs
+doc/_build/
+doc/source/api/
\ No newline at end of file
diff --git a/AUTHORS b/AUTHORS
index 600b719..3d923f3 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,4 +1,4 @@
-# This is the list of ansys-tools-visualization-interface's significant contributors.
+# This is the list of allie-flowkit-python's significant contributors.
 #
 # This file does not necessarily list everyone who has contributed code.
 #
diff --git a/doc/ANSYS/accept.txt b/doc/ANSYS/accept.txt
new file mode 100644
index 0000000..071cc07
--- /dev/null
+++ b/doc/ANSYS/accept.txt
@@ -0,0 +1,2 @@
+(?i)Ansys
+pytest
\ No newline at end of file
diff --git a/doc/ANSYS/reject.txt b/doc/ANSYS/reject.txt
new file mode 100644
index 0000000..e69de29
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..d922f9f
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,38 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -j auto -W --color
+SPHINXBUILD   = sphinx-build
+APIDIR        = api
+EXAMPLESDIR        = examples
+SOURCEDIR     = source
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Customized clean due to examples gallery
+clean:
+	rm -rf $(BUILDDIR)/*
+	find . -type d -name $(APIDIR) -exec rm -rf {} +
+	find . -type d -name $(EXAMPLESDIR) -exec rm -rf {} +
+
+# Create PDF
+pdf:
+	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
+
+# Build HTML files and generate examples as .py files
+html:
+	pip uninstall vtk -y
+	pip install --extra-index-url https://wheels.vtk.org vtk-osmesa
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/make.bat b/doc/make.bat
new file mode 100644
index 0000000..a5c1640
--- /dev/null
+++ b/doc/make.bat
@@ -0,0 +1,64 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+if "%SPHINXOPTS%" == "" (
+	set SPHINXOPTS=-j auto -W --color
+)
+set SOURCEDIR=source
+set APIDIR=api
+set EXAMPLESDIR=examples
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+if "%1" == "clean" goto clean
+if "%1" == "pdf" goto pdf
+if "%1" == "html" goto html
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:html
+%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:pdf
+%SPHINXBUILD% -M latex %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+cd "%BUILDDIR%\latex"
+for %%f in (*.tex) do (
+pdflatex "%%f" --interaction=nonstopmode)
+if NOT EXIST allie-flowkit-python.pdf (
+	Echo "no pdf generated!"
+	exit /b 1)
+Echo "pdf generated!"
+goto end
+
+:clean
+rmdir /s /q %BUILDDIR% > /NUL 2>&1
+for /d /r %SOURCEDIR% %%d in (%APIDIR%, %EXAMPLESDIR%) do @if exist "%%d" rmdir /s /q "%%d"
+goto end
+
+:end
+popd
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..8160eec
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,241 @@
+"""Sphinx documentation configuration file."""
+
+from datetime import datetime
+import os
+from pathlib import Path
+
+from allie.flowkit import __version__
+from ansys_sphinx_theme import (
+    ansys_favicon,
+    ansys_logo_white,
+    ansys_logo_white_cropped,
+    get_autoapi_templates_dir_relative_path,
+    get_version_match,
+    latex,
+    pyansys_logo_black,
+    watermark,
+)
+from sphinx.builders.latex import LaTeXBuilder
+
+LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]
+
+# Project information
+project = "allie-flowkit-python"
+copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
+author = "ANSYS, Inc."
+release = version = __version__
+cname = os.getenv("DOCUMENTATION_CNAME", default="allie-flowkit-python.docs.pyansys.com")
+switcher_version = get_version_match(__version__)
+
+# Select desired logo, theme, and declare the html title
+html_logo = pyansys_logo_black
+html_theme = "ansys_sphinx_theme"
+html_short_title = html_title = "Allie Flowkit Python"
+html_baseurl = f"https://{cname}/version/stable"
+
+# specify the location of your github repo
+html_context = {
+    "github_user": "ansys",
+    "github_repo": "allie-flowkit-python",
+    "github_version": "main",
+    "doc_path": "doc/source",
+}
+html_theme_options = {
+    "switcher": {
+        "json_url": f"https://{cname}/versions.json",
+        "version_match": switcher_version,
+    },
+    "check_switcher": False,
+    "github_url": "https://github.com/ansys/allie-flowkit-python",
+    "show_prev_next": False,
+    "show_breadcrumbs": True,
+    "collapse_navigation": True,
+    "use_edit_page_button": True,
+    "additional_breadcrumbs": [
+        ("PyAnsys", "https://docs.pyansys.com/"),
+    ],
+    "icon_links": [
+        {
+            "name": "Support",
+            "url": "https://github.com/ansys/allie-flowkit-python/discussions",
+            "icon": "fa fa-comment fa-fw",
+        },
+        {
+            "name": "Download documentation in PDF",
+            "url": f"https://{cname}/version/{switcher_version}/_static/assets/download/allie-flowkit-python.pdf",  # noqa: E501
+            "icon": "fa fa-file-pdf fa-fw",
+        },
+    ]
+}
+
+# Sphinx extensions
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_jinja",
+    "autoapi.extension",
+    "numpydoc",
+]
+
+nbsphinx_execute = "always"
+sphinx_gallery_conf = {
+    # path to your examples scripts
+    "examples_dirs": ["../../examples"],
+    # path where to save gallery generated examples
+    "gallery_dirs": ["examples"],
+    # Pattern to search for example files
+    "filename_pattern": r"\.py",
+    # Remove the "Download all examples" button from the top level gallery
+    "download_all_examples": False,
+    # Sort gallery example by file name instead of number of lines (default)
+    # directory where function granular galleries are stored
+    "backreferences_dir": None,
+    # Modules for which function level galleries are created.  In
+    "doc_module": "allie-flowkit-python",
+    "ignore_pattern": "flycheck*",
+    "thumbnail_size": (350, 350),
+    "remove_config_comments": True,
+    "show_signature": False,
+}
+
+
+# Intersphinx mapping
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.11", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "pyvista": ("https://docs.pyvista.org/version/stable", None),
+    "grpc": ("https://grpc.github.io/grpc/python/", None),
+    "pint": ("https://pint.readthedocs.io/en/stable", None),
+    "beartype": ("https://beartype.readthedocs.io/en/stable/", None),
+    "docker": ("https://docker-py.readthedocs.io/en/stable/", None),
+    "pypim": ("https://pypim.docs.pyansys.com/version/stable", None),
+}
+
+# numpydoc configuration
+numpydoc_show_class_members = False
+numpydoc_xref_param_type = True
+
+# Consider enabling numpydoc validation. See:
+# https://numpydoc.readthedocs.io/en/latest/validation.html#
+numpydoc_validate = True
+numpydoc_validation_checks = {
+    "GL06",  # Found unknown section
+    "GL07",  # Sections are in the wrong order.
+    # "GL08",  # The object does not have a docstring
+    "GL09",  # Deprecation warning should precede extended summary
+    "GL10",  # reST directives {directives} must be followed by two colons
+    "SS01",  # No summary found
+    "SS02",  # Summary does not start with a capital letter
+    # "SS03", # Summary does not end with a period
+    "SS04",  # Summary contains heading whitespaces
+    # "SS05", # Summary must start with infinitive verb, not third person
+    "RT02",  # The first line of the Returns section should contain only the
+    # type, unless multiple values are being returned"
+}
+
+html_favicon = ansys_favicon
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
+# The master toctree document.
+master_doc = "index"
+
+# Configuration for Sphinx autoapi
+autoapi_type = "python"
+autoapi_dirs = ["../../src"]
+autoapi_root = "api"
+autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__))
+suppress_warnings = ["autoapi.python_import_resolution", "design.grid", "config.cache",  "autoapi.not_readable"]
+autoapi_python_use_implicit_namespaces = True
+autoapi_keep_files = True
+autoapi_own_page_level = "class"
+autoapi_add_toctree_entry = False
+# Examples gallery customization
+nbsphinx_execute = "always"
+
+nbsphinx_epilog = """
+----
+
+.. admonition:: Download this example
+
+    Download this example as a `Jupyter Notebook <{cname_pref}/{ipynb_file_loc}>`_
+    or as a `Python script <{cname_pref}/{py_file_loc}>`_.
+
+""".format(
+    cname_pref=f"https://{cname}/version/{switcher_version}",
+    ipynb_file_loc="{{ env.docname }}.ipynb",
+    py_file_loc="{{ env.docname }}.py",
+)
+
+nbsphinx_prolog = """
+
+.. admonition:: Download this example
+
+    Download this example as a `Jupyter Notebook <{cname_pref}/{ipynb_file_loc}>`_
+    or as a `Python script <{cname_pref}/{py_file_loc}>`_.
+
+----
+""".format(
+    cname_pref=f"https://{cname}/version/{switcher_version}",
+    ipynb_file_loc="{{ env.docname }}.ipynb",
+    py_file_loc="{{ env.docname }}.py",
+)
+
+typehints_defaults = "comma"
+simplify_optional_unions = False
+
+# additional logos for the latex coverpage
+latex_additional_files = [watermark, ansys_logo_white, ansys_logo_white_cropped]
+
+# change the preamble of latex with customized title page
+# variables are the title of pdf, watermark
+latex_elements = {"preamble": latex.generate_preamble(html_title)}
+
+linkcheck_exclude_documents = ["index", "getting_started/local/index", "assets"]
+
+# -- Declare the Jinja context -----------------------------------------------
+exclude_patterns = [
+    "examples/**/*.ipynb",
+    "examples/**/*.py",
+    "examples/**/*.md5",
+    "api/ansys/visualizer/index.rst",
+]
+
+BUILD_API = True
+if not BUILD_API:
+    exclude_patterns.append("autoapi")
+
+BUILD_EXAMPLES = True
+if not BUILD_EXAMPLES:
+    exclude_patterns.append("examples/**")
+    exclude_patterns.append("examples.rst")
+
+jinja_contexts = {
+    "main_toctree": {
+        "build_api": BUILD_API,
+        "build_examples": BUILD_EXAMPLES,
+    }
+}
+
+
+def prepare_jinja_env(jinja_env) -> None:
+    """Customize the jinja env.
+
+    Notes
+    -----
+    See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
+
+    """
+    jinja_env.globals["project_name"] = project
+
+
+autoapi_prepare_jinja_env = prepare_jinja_env
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
new file mode 100644
index 0000000..828645c
--- /dev/null
+++ b/doc/source/contributing.rst
@@ -0,0 +1,11 @@
+.. _contribute:
+
+Contribute
+##########
+
+Overall guidance on contributing to a PyAnsys library appears in the
+`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
+in the *PyAnsys developer's guide*. Ensure that you are thoroughly familiar
+with this guide before attempting to contribute to the Allie Flowkit Python.
+
+The following contribution information is specific to the Allie Flowkit Python.
diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst
new file mode 100644
index 0000000..9a19fef
--- /dev/null
+++ b/doc/source/examples/index.rst
@@ -0,0 +1,7 @@
+.. _ref_examples:
+
+Examples
+========
+
+This section show how to use the Allie Flowkit Python to perform many different
+types of operations.
diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
new file mode 100644
index 0000000..117efbb
--- /dev/null
+++ b/doc/source/getting_started/index.rst
@@ -0,0 +1,39 @@
+.. _ref_getting_started:
+
+Getting started
+###############
+
+This section describes how to install the Allie Flowkit Python in user mode and
+quickly begin using it. If you are interested in contributing to the Allie Flowkit Python,
+see :ref:`contribute` for information on installing in developer mode.
+
+Installation
+============
+
+To use `pip <https://pypi.org/project/pip/>`_ to install the Allie Flowkit Python,
+run this command:
+
+.. code:: bash
+
+        pip install allie-flowkit-python
+
+Alternatively, to install the latest version from this library's
+`GitHub repository <https://github.com/ansys/allie-flowkit-python/>`_,
+run these commands:
+
+.. code:: bash
+
+    git clone https://github.com/ansys/allie-flowkit-python
+    cd allie-flowkit-python
+    pip install .
+
+Quick start
+^^^^^^^^^^^
+
+The following examples show how to use the Allie Flowkit Python.
+
+.. code:: bash
+
+    allie-flowkit-python --host 0.0.0.0 --port 50052 --workers 1
+
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..f216530
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,77 @@
+Allie Flowkit Python documentation |version|
+====================================================
+
+The Allie Flowkit Python is a Python API that provides an interface between PyAnsys libraries and
+different plotting backends.
+
+The Allie Flowkit Python offers these main features:
+
+* Serves as an interface between PyAnsys and other plotting libraries (although only
+  `PyVista <https://docs.pyvista.org/version/stable/>`_ is supported currently).
+* Provides out-of-the box picking, viewing, and measuring functionalities.
+* Supplies an extensible class for adding custom functionalities.
+
+.. grid:: 1 2 2 2
+
+
+    .. grid-item-card:: Getting started :material-regular:`directions_run`
+        :padding: 2 2 2 2
+        :link: getting_started/index
+        :link-type: doc
+
+        Learn how to install the Allie Flowkit Python in user mode and quickly
+        begin using it.
+
+    .. grid-item-card:: User guide :material-regular:`menu_book`
+        :padding: 2 2 2 2
+        :link: user_guide/index
+        :link-type: doc
+
+        Understand key concepts for implementing the Allie Flowkit Python in
+        your workflow.
+
+    .. jinja:: main_toctree
+
+        {% if build_api %}
+        .. grid-item-card:: API reference :material-regular:`bookmark`
+            :padding: 2 2 2 2
+            :link: api/src/allie/flowkit/index
+            :link-type: doc
+
+            Understand how to use Python to interact programmatically with
+            the Allie Flowkit Python.
+        {% endif %}
+
+        {% if build_examples %}
+        .. grid-item-card:: Examples :material-regular:`play_arrow`
+            :padding: 2 2 2 2
+            :link: examples/index
+            :link-type: doc
+
+            Explore examples that show how to use the Allie Flowkit Python to
+            perform many different types of operations.
+        {% endif %}
+
+        .. grid-item-card:: Contribute :material-regular:`group`
+            :padding: 2 2 2 2
+            :link: contributing
+            :link-type: doc
+
+            Learn how to contribute to the Allie Flowkit Python codebase or documentation.
+
+
+.. jinja:: main_toctree
+
+    .. toctree::
+       :hidden:
+       :maxdepth: 3
+
+       getting_started/index
+       user_guide/index
+       {% if build_api %}
+       api/src/allie/flowkit/index
+       {% endif %}
+       {% if build_examples %}
+       examples/index
+       {% endif %}
+       contributing
\ No newline at end of file
diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst
new file mode 100644
index 0000000..dd33799
--- /dev/null
+++ b/doc/source/user_guide/index.rst
@@ -0,0 +1,9 @@
+.. _ref_user_guide:
+
+==========
+User guide
+==========
+
+This section explains key concepts for implementing the Allie Flowkit Python in your workflow.
+You can use the Allie Flowkit Python in your examples as well as integrate this library into
+your own code.
diff --git a/pyproject.toml b/pyproject.toml
index c0e42d7..1f2369a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -34,6 +34,19 @@ dependencies = [
 all = [
     "uvicorn[standard] >= 0.30.5,<1",
 ]
+doc = [
+    "ansys-sphinx-theme==0.16.6",
+    "jupyter_sphinx==0.5.3",
+    "jupytext==1.16.4",
+    "nbsphinx==0.9.4",
+    "numpydoc==1.7.0",
+    "sphinx==8.0.2",
+    "sphinx-autoapi==3.2.1",
+    "sphinx-copybutton==0.5.2",
+    "sphinx_design==0.6.1",
+    "sphinx-gallery==0.17.0",
+    "sphinx-jinja==2.0.2",
+]
 
 [project.urls]
 Source = "https://github.com/ansys/allie-flowkit-python"
diff --git a/src/allie/flowkit/config/_config.py b/src/allie/flowkit/config/_config.py
index 6afe67d..dfebde7 100644
--- a/src/allie/flowkit/config/_config.py
+++ b/src/allie/flowkit/config/_config.py
@@ -69,8 +69,11 @@ def _load_config(self, config_path: str) -> dict:
                 with Path("configs/config.yaml").open("r") as file:
                     return yaml.safe_load(file)
             except FileNotFoundError:
-                raise FileNotFoundError("Configuration file not found at the default location.")
-
+                try:
+                    with Path("../../configs/config.yaml").open("r") as file:
+                        return yaml.safe_load(file)
+                except FileNotFoundError:
+                    raise FileNotFoundError("Configuration file not found at the default location.")
 
 # Initialize the config object
 CONFIG = Config()

From 3e17373cbbf245c9d7f6610df80525f7bc4f777c Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:52:47 +0200
Subject: [PATCH 10/35] maint: Add doc build action

---
 .github/workflows/ci_cd.yml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index d04afe8..5509716 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -47,6 +47,28 @@ jobs:
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
 
+  docs-style:
+    name: Documentation Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys documentation style checks
+        uses: ansys/actions/doc-style@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  docs-build:
+    name: Documentation Build
+    runs-on: ubuntu-latest
+    needs: [docs-style]
+    steps:
+    - name: Setup headless display
+      uses: pyvista/setup-headless-display-action@v2
+
+    - name: "Run Ansys documentation building action"
+      uses: ansys/actions/doc-build@v6
+      with:
+        add-pdf-html-docs-as-assets: true
+
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')

From 76095143394b5b4b616745589859963907b1abaf Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:55:59 +0200
Subject: [PATCH 11/35] fix: Vale structure

---
 doc/{ => styles/config/vocabularies}/ANSYS/accept.txt | 0
 doc/{ => styles/config/vocabularies}/ANSYS/reject.txt | 0
 2 files changed, 0 insertions(+), 0 deletions(-)
 rename doc/{ => styles/config/vocabularies}/ANSYS/accept.txt (100%)
 rename doc/{ => styles/config/vocabularies}/ANSYS/reject.txt (100%)

diff --git a/doc/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt
similarity index 100%
rename from doc/ANSYS/accept.txt
rename to doc/styles/config/vocabularies/ANSYS/accept.txt
diff --git a/doc/ANSYS/reject.txt b/doc/styles/config/vocabularies/ANSYS/reject.txt
similarity index 100%
rename from doc/ANSYS/reject.txt
rename to doc/styles/config/vocabularies/ANSYS/reject.txt

From 5f05a3648049868c3d5304e45262c5e49810888c Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:57:20 +0200
Subject: [PATCH 12/35] fix: Add vale ini

---
 doc/.vale.ini | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 doc/.vale.ini

diff --git a/doc/.vale.ini b/doc/.vale.ini
new file mode 100644
index 0000000..c148a37
--- /dev/null
+++ b/doc/.vale.ini
@@ -0,0 +1,31 @@
+# Core settings
+# =============
+
+# Location of our `styles`
+StylesPath = "styles"
+
+# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
+MinAlertLevel = warning
+
+# By default, `code` and `tt` are ignored.
+IgnoredScopes = code, tt
+
+# By default, `script`, `style`, `pre`, and `figure` are ignored.
+SkippedScopes = script, style, pre, figure
+
+# WordTemplate specifies what Vale will consider to be an individual word.
+WordTemplate = \b(?:%s)\b
+
+# List of Packages to be used for our guidelines
+Packages = Google
+
+# Define the Ansys vocabulary
+Vocab = ANSYS
+
+[*.{md,rst}]
+
+# Apply the following styles
+[*.{rst}]
+BasedOnStyles = Vale, Google
+Vale.Terms = NO
+Google.Headings = NO
\ No newline at end of file

From 51e10a08ee5dfbd8896633859746bcc1b9ec1181 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 10:59:28 +0200
Subject: [PATCH 13/35] fix: Admit flowkit

---
 doc/styles/config/vocabularies/ANSYS/accept.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt
index 071cc07..b7774a9 100644
--- a/doc/styles/config/vocabularies/ANSYS/accept.txt
+++ b/doc/styles/config/vocabularies/ANSYS/accept.txt
@@ -1,2 +1,3 @@
 (?i)Ansys
-pytest
\ No newline at end of file
+pytest
+(?i)Flowkit
\ No newline at end of file

From 98189d22b1ba1820ccde046af8cf2c40423ef90b Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:05:48 +0200
Subject: [PATCH 14/35] fix: Temp ignore repo link

---
 doc/source/conf.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 8160eec..a177526 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -201,7 +201,9 @@
 latex_elements = {"preamble": latex.generate_preamble(html_title)}
 
 linkcheck_exclude_documents = ["index", "getting_started/local/index", "assets"]
-
+linkcheck_ignore = [
+    "https://github.com/ansys/allie-flowkit-python/"
+]
 # -- Declare the Jinja context -----------------------------------------------
 exclude_patterns = [
     "examples/**/*.ipynb",

From 85d5bbc93553d4612eba98d861e83073c5eacc66 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:11:21 +0200
Subject: [PATCH 15/35] maint: Add documentation deploy

---
 .github/workflows/ci_cd.yml | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index 5509716..f6bbbdb 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -9,6 +9,7 @@ on:
 
 env:
   MAIN_PYTHON_VERSION: '3.12'
+  DOCUMENTATION_CNAME: allie-flowkit-python.docs.pyansys.com
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -69,6 +70,19 @@ jobs:
       with:
         add-pdf-html-docs-as-assets: true
 
+  upload_dev_docs:
+    name: Upload dev documentation
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: [package]
+    steps:
+      - name: Deploy the latest documentation
+        uses: ansys/actions/doc-deploy-dev@v6
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
@@ -83,6 +97,19 @@ jobs:
         with:
           generate_release_notes: true
 
+  upload_docs_release:
+    name: Upload release documentation
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: [release]
+    steps:
+      - name: Deploy the stable documentation
+        uses: ansys/actions/doc-deploy-stable@v6
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+
   release-docker:
     name : Generate Docker release
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')

From 1966223f5d3b76144b8ba374a7cae450a3f67197 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:16:30 +0200
Subject: [PATCH 16/35] fix: Add package name

---
 .github/workflows/ci_cd.yml | 1 +
 pyproject.toml              | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index f6bbbdb..b8475a4 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -10,6 +10,7 @@ on:
 env:
   MAIN_PYTHON_VERSION: '3.12'
   DOCUMENTATION_CNAME: allie-flowkit-python.docs.pyansys.com
+  PACKAGE_NAME: allie-flowkit-python
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
diff --git a/pyproject.toml b/pyproject.toml
index 1f2369a..3c29f1c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "allie-flowkit"
+name = "allie-flowkit-python"
 version = "0.1.dev0"
 description = ""
 readme = "README.md"

From 0fa67895e460b65de81a9b1e15e0ace4945f06a2 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:21:16 +0200
Subject: [PATCH 17/35] fix: Add package action

---
 .github/workflows/ci_cd.yml | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index b8475a4..c86501d 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -71,6 +71,17 @@ jobs:
       with:
         add-pdf-html-docs-as-assets: true
 
+  package:
+    name: Package library
+    needs: [docs-build, smoke-tests]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build library source and wheel artifacts
+        uses: ansys/actions/build-library@v6
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
   upload_dev_docs:
     name: Upload dev documentation
     if: github.ref == 'refs/heads/main'

From 32f1be7cb02ca9e234d04ac39932cda3f799a7b4 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:26:16 +0200
Subject: [PATCH 18/35] fix: Version getter

---
 src/allie/flowkit/__init__.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
index 8e2f692..1ee0793 100644
--- a/src/allie/flowkit/__init__.py
+++ b/src/allie/flowkit/__init__.py
@@ -1,6 +1,6 @@
 """App package responsible for creating the FastAPI app."""
 import importlib.metadata as importlib_metadata
 
-__version__ = importlib_metadata.version(__name__.replace(".", "-"))
+__version__ = importlib_metadata.version(__name__.replace(".", "-") + "-python")
 
 from allie.flowkit.flowkit_service import flowkit_service  # noqa F401

From cd9fb40ad007044b3115cf8daae53776392d9f94 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:33:50 +0200
Subject: [PATCH 19/35] maint: Add license and license header action

---
 .pre-commit-config.yaml |  8 ++++++++
 LICENSE                 | 21 +++++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 LICENSE

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index cc07e30..07befc0 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -32,3 +32,11 @@ repos:
   hooks:
     - id: ruff
       args: [--fix]
+
+- repo: https://github.com/ansys/pre-commit-hooks
+  rev: v0.3.1
+  hooks:
+    - id: add-license-headers
+      files: '(src|examples|tests|docker)/.*\.(py)|\.(proto)'
+      args:
+      - --start_year=2024
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0add157
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ANSYS, Inc. and/or its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

From cfc5972f1f275c89870eb5416a5bdf3c435fa790 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:35:32 +0200
Subject: [PATCH 20/35] maint: Add license headers

---
 src/allie/flowkit/__init__.py           | 22 ++++++++++++++++++++++
 src/allie/flowkit/__main__.py           | 22 ++++++++++++++++++++++
 src/allie/flowkit/config/__init__.py    | 22 ++++++++++++++++++++++
 src/allie/flowkit/config/_config.py     | 22 ++++++++++++++++++++++
 src/allie/flowkit/endpoints/__init__.py | 22 ++++++++++++++++++++++
 src/allie/flowkit/endpoints/splitter.py | 22 ++++++++++++++++++++++
 src/allie/flowkit/fastapi_utils.py      | 22 ++++++++++++++++++++++
 src/allie/flowkit/flowkit_service.py    | 22 ++++++++++++++++++++++
 src/allie/flowkit/models/__init__.py    | 22 ++++++++++++++++++++++
 src/allie/flowkit/models/functions.py   | 22 ++++++++++++++++++++++
 src/allie/flowkit/models/splitter.py    | 22 ++++++++++++++++++++++
 11 files changed, 242 insertions(+)

diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
index 1ee0793..638e0e3 100644
--- a/src/allie/flowkit/__init__.py
+++ b/src/allie/flowkit/__init__.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """App package responsible for creating the FastAPI app."""
 import importlib.metadata as importlib_metadata
 
diff --git a/src/allie/flowkit/__main__.py b/src/allie/flowkit/__main__.py
index 71f3771..86eda4a 100644
--- a/src/allie/flowkit/__main__.py
+++ b/src/allie/flowkit/__main__.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Main module for the FlowKit service."""
 try:
     import uvicorn
diff --git a/src/allie/flowkit/config/__init__.py b/src/allie/flowkit/config/__init__.py
index c1cdd83..86b793f 100644
--- a/src/allie/flowkit/config/__init__.py
+++ b/src/allie/flowkit/config/__init__.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Configuration package for the application."""
 
 from allie.flowkit.config._config import CONFIG # noqa F401
diff --git a/src/allie/flowkit/config/_config.py b/src/allie/flowkit/config/_config.py
index dfebde7..612d6c1 100644
--- a/src/allie/flowkit/config/_config.py
+++ b/src/allie/flowkit/config/_config.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Module for reading the configuration settings from a YAML file."""
 import os
 from pathlib import Path
diff --git a/src/allie/flowkit/endpoints/__init__.py b/src/allie/flowkit/endpoints/__init__.py
index d9e6743..e5f13a3 100644
--- a/src/allie/flowkit/endpoints/__init__.py
+++ b/src/allie/flowkit/endpoints/__init__.py
@@ -1 +1,23 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Endpoints package responsible for defining the endpoints."""
diff --git a/src/allie/flowkit/endpoints/splitter.py b/src/allie/flowkit/endpoints/splitter.py
index ad75b55..3f853b8 100644
--- a/src/allie/flowkit/endpoints/splitter.py
+++ b/src/allie/flowkit/endpoints/splitter.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Module for splitting text into chunks."""
 import base64
 import io
diff --git a/src/allie/flowkit/fastapi_utils.py b/src/allie/flowkit/fastapi_utils.py
index c3ccacc..304ab06 100644
--- a/src/allie/flowkit/fastapi_utils.py
+++ b/src/allie/flowkit/fastapi_utils.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Utils module for FastAPI related operations."""
 import inspect
 from typing import Any, Dict, List, Type, get_type_hints
diff --git a/src/allie/flowkit/flowkit_service.py b/src/allie/flowkit/flowkit_service.py
index d0875e9..79f2e34 100644
--- a/src/allie/flowkit/flowkit_service.py
+++ b/src/allie/flowkit/flowkit_service.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Module for the Allie Flowkit service."""
 from typing import List
 
diff --git a/src/allie/flowkit/models/__init__.py b/src/allie/flowkit/models/__init__.py
index a19d65b..fd4aed7 100644
--- a/src/allie/flowkit/models/__init__.py
+++ b/src/allie/flowkit/models/__init__.py
@@ -1 +1,23 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Models package used to define the data models."""
diff --git a/src/allie/flowkit/models/functions.py b/src/allie/flowkit/models/functions.py
index 4cb439a..9d3a380 100644
--- a/src/allie/flowkit/models/functions.py
+++ b/src/allie/flowkit/models/functions.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Module for defining the models used in the endpoints."""
 from typing import Any, Dict, List
 
diff --git a/src/allie/flowkit/models/splitter.py b/src/allie/flowkit/models/splitter.py
index dc019fc..36225d2 100644
--- a/src/allie/flowkit/models/splitter.py
+++ b/src/allie/flowkit/models/splitter.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Model for the splitter endpoint."""
 from typing import List
 

From c905487b2d36e01f43edacd511821b09475a1e78 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Tue, 6 Aug 2024 11:43:45 +0200
Subject: [PATCH 21/35] fix: restore dockerfile defaults

---
 docker/Dockerfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docker/Dockerfile b/docker/Dockerfile
index 28c9010..5835569 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -16,4 +16,4 @@ EXPOSE 8000
 ENV WORKERS=4
 
 # Use the environment variable in CMD
-CMD ["sh", "-c", "allie-flowkit"]
\ No newline at end of file
+CMD ["sh", "-c", "allie-flowkit --host 0.0.0.0 --port 8000 --workers $WORKERS"]
\ No newline at end of file

From e6d856b7a8d4e958d79b60202e035f278a4e8253 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 08:46:59 +0200
Subject: [PATCH 22/35] fix: Several small fixes

---
 .gitignore                    | 2 +-
 doc/source/conf.py            | 2 --
 doc/source/index.rst          | 8 ++------
 docker/Dockerfile             | 3 +--
 src/allie/flowkit/__main__.py | 1 -
 5 files changed, 4 insertions(+), 12 deletions(-)

diff --git a/.gitignore b/.gitignore
index 9641641..2453a3e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -44,4 +44,4 @@ config.yaml
 
 # Docs
 doc/_build/
-doc/source/api/
\ No newline at end of file
+doc/source/api/
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a177526..2670545 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -105,7 +105,6 @@
     "python": ("https://docs.python.org/3.11", None),
     "numpy": ("https://numpy.org/doc/stable", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),
-    "pyvista": ("https://docs.pyvista.org/version/stable", None),
     "grpc": ("https://grpc.github.io/grpc/python/", None),
     "pint": ("https://pint.readthedocs.io/en/stable", None),
     "beartype": ("https://beartype.readthedocs.io/en/stable/", None),
@@ -209,7 +208,6 @@
     "examples/**/*.ipynb",
     "examples/**/*.py",
     "examples/**/*.md5",
-    "api/ansys/visualizer/index.rst",
 ]
 
 BUILD_API = True
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f216530..6ffa99c 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,15 +1,11 @@
 Allie Flowkit Python documentation |version|
 ====================================================
 
-The Allie Flowkit Python is a Python API that provides an interface between PyAnsys libraries and
-different plotting backends.
+The Allie Flowkit Python is a Python service that exposes features from Allie Flowkit to Python users. This documentation provides information on how to install and use the Allie Flowkit Python.
 
 The Allie Flowkit Python offers these main features:
 
-* Serves as an interface between PyAnsys and other plotting libraries (although only
-  `PyVista <https://docs.pyvista.org/version/stable/>`_ is supported currently).
-* Provides out-of-the box picking, viewing, and measuring functionalities.
-* Supplies an extensible class for adding custom functionalities.
+
 
 .. grid:: 1 2 2 2
 
diff --git a/docker/Dockerfile b/docker/Dockerfile
index 5835569..df4e4f5 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -3,7 +3,6 @@ FROM python:3.12-slim
 WORKDIR /app
 
 # Copy the app folder and the config.yaml file
-COPY requirements.txt .
 COPY app/ ./src/allie/flowkit/
 COPY configs/config.yaml .
 
@@ -16,4 +15,4 @@ EXPOSE 8000
 ENV WORKERS=4
 
 # Use the environment variable in CMD
-CMD ["sh", "-c", "allie-flowkit --host 0.0.0.0 --port 8000 --workers $WORKERS"]
\ No newline at end of file
+CMD ["sh", "-c", "allie-flowkit-python --host 0.0.0.0 --port 8000 --workers $WORKERS"]
\ No newline at end of file
diff --git a/src/allie/flowkit/__main__.py b/src/allie/flowkit/__main__.py
index 86eda4a..4d3ca42 100644
--- a/src/allie/flowkit/__main__.py
+++ b/src/allie/flowkit/__main__.py
@@ -39,6 +39,5 @@ def main():
     args = parse.parse_args()
     uvicorn.run("allie.flowkit:flowkit_service", host=args.host, port=args.port, workers=args.workers)
 
-
 if __name__ == "__main__":
     main()

From 5418acf33e901224f405b4a055385b1041448377 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 09:05:40 +0200
Subject: [PATCH 23/35] fix: Adapt tests to new changes

---
 pyproject.toml                   |  5 ++++-
 setup.py                         |  7 -------
 tests/__init__.py                | 22 ++++++++++++++++++++++
 tests/conftest.py                | 22 ++++++++++++++++++++++
 tests/test_endpoints_splitter.py | 25 ++++++++++++++++++++++++-
 tests/test_list_functions.py     | 22 ++++++++++++++++++++++
 6 files changed, 94 insertions(+), 9 deletions(-)
 delete mode 100644 setup.py

diff --git a/pyproject.toml b/pyproject.toml
index b82bbd2..ffb956e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -115,4 +115,7 @@ known-first-party = ["ansys"]
 
 [tool.ruff.lint.pydocstyle]
 # Settings: https://docs.astral.sh/ruff/settings/#lintpydocstyle
-convention = "google"
\ No newline at end of file
+convention = "google"
+
+[tool.setuptools.packages.find]
+include = ["app", "docker", "configs"]
\ No newline at end of file
diff --git a/setup.py b/setup.py
deleted file mode 100644
index 0033fb9..0000000
--- a/setup.py
+++ /dev/null
@@ -1,7 +0,0 @@
-from setuptools import find_packages, setup
-
-setup(
-    name="ansys-allie-flowkit-python",
-    version="0.1.0",
-    packages=find_packages(include=["app", "docker", "configs"]),
-)
diff --git a/tests/__init__.py b/tests/__init__.py
index f1b390f..b4a288b 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -1 +1,23 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Tests module."""
diff --git a/tests/conftest.py b/tests/conftest.py
index 4f9d61d..429aba8 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Module for test helper functions."""
 from unittest.mock import patch
 
 import pytest
diff --git a/tests/test_endpoints_splitter.py b/tests/test_endpoints_splitter.py
index c947fda..b1837e8 100644
--- a/tests/test_endpoints_splitter.py
+++ b/tests/test_endpoints_splitter.py
@@ -1,4 +1,27 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Test module for the splitter endpoints."""
 import base64
+from pathlib import Path
 
 from app.app import app
 from app.endpoints.splitter import validate_request
@@ -15,7 +38,7 @@
 
 def encode_file_to_base64(file_path):
     """Encode a file to base64 string."""
-    with open(file_path, "rb") as file:
+    with Path(file_path).open("rb") as file:
         return base64.b64encode(file.read()).decode("utf-8")
 
 
diff --git a/tests/test_list_functions.py b/tests/test_list_functions.py
index c2e50b4..e72d066 100644
--- a/tests/test_list_functions.py
+++ b/tests/test_list_functions.py
@@ -1,3 +1,25 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Test module for list functions."""
 from app.app import app
 from fastapi.testclient import TestClient
 import pytest

From e7c6b8951f497bcdb0fb77bcc7a8754d4e11a662 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 09:30:50 +0200
Subject: [PATCH 24/35] fix: Imports

---
 tests/test_endpoints_splitter.py | 8 ++++----
 tests/test_list_functions.py     | 4 ++--
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/tests/test_endpoints_splitter.py b/tests/test_endpoints_splitter.py
index b1837e8..9634533 100644
--- a/tests/test_endpoints_splitter.py
+++ b/tests/test_endpoints_splitter.py
@@ -23,9 +23,9 @@
 import base64
 from pathlib import Path
 
-from app.app import app
-from app.endpoints.splitter import validate_request
-from app.models.splitter import SplitterRequest
+from allie.flowkit import flowkit_service
+from allie.flowkit.endpoints.splitter import validate_request
+from allie.flowkit.models.splitter import SplitterRequest
 from fastapi import HTTPException
 from fastapi.testclient import TestClient
 import pytest
@@ -33,7 +33,7 @@
 from tests.conftest import MOCK_API_KEY
 
 # Create a test client
-client = TestClient(app)
+client = TestClient(flowkit_service)
 
 
 def encode_file_to_base64(file_path):
diff --git a/tests/test_list_functions.py b/tests/test_list_functions.py
index e72d066..a6d791d 100644
--- a/tests/test_list_functions.py
+++ b/tests/test_list_functions.py
@@ -20,12 +20,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Test module for list functions."""
-from app.app import app
+from allie.flowkit import flowkit_service
 from fastapi.testclient import TestClient
 import pytest
 
 # Initialize the test client
-client = TestClient(app)
+client = TestClient(flowkit_service)
 
 
 @pytest.mark.asyncio

From 548e741dd4856646cbc5d9a366c56b2756ab9423 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 09:53:06 +0200
Subject: [PATCH 25/35] fix: Adapt CICD tests

---
 .github/workflows/ci_cd.yml | 18 +-----------------
 pyproject.toml              |  5 ++++-
 2 files changed, 5 insertions(+), 18 deletions(-)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index 4510ddb..6bc0ce6 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -98,33 +98,17 @@ jobs:
   tests:
     name: "Tests"
     runs-on: ${{ matrix.os }}
-    needs: [code-style]
+    needs: [smoke-tests]
     strategy:
       matrix:
        os: [ubuntu-latest, windows-latest]
        python-version: ['3.9', '3.12']
       fail-fast: false
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
 
       - name: Testing
         uses: ansys/actions/tests-pytest@v6
         timeout-minutes: 12
-        with:
-          checkout: false
-          skip-install: true
-          pytest-extra-args: "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
 
       - name: Upload coverage results (HTML)
         uses: actions/upload-artifact@v4
diff --git a/pyproject.toml b/pyproject.toml
index ffb956e..df6e909 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -118,4 +118,7 @@ known-first-party = ["ansys"]
 convention = "google"
 
 [tool.setuptools.packages.find]
-include = ["app", "docker", "configs"]
\ No newline at end of file
+include = ["app", "docker", "configs"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
\ No newline at end of file

From ee578195c8be2fdc0afda6502b10d74fcf6603da Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 09:58:20 +0200
Subject: [PATCH 26/35] fix: String import

---
 tests/conftest.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/conftest.py b/tests/conftest.py
index 429aba8..ee67eaf 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -31,5 +31,5 @@
 @pytest.fixture(autouse=True)
 def mock_api_key():
     """Mock the API key for testing."""
-    with patch("app.config.CONFIG.flowkit_python_api_key", MOCK_API_KEY):
+    with patch("allie.flowkit.config.CONFIG.flowkit_python_api_key", MOCK_API_KEY):
         yield

From 9f64e93cc0fae2fd94c93854b3e1cba811ff9903 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 10:06:52 +0200
Subject: [PATCH 27/35] fix: Add asyncio plugin

---
 pyproject.toml | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index df6e909..7aace36 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -40,6 +40,7 @@ all = [
 tests = [
     "pytest >= 8.3.2,<9",
     "pytest-cov >= 5.0.0,<6",
+    "pytest-asyncio >= 0.23.8,<1",
 ]
 doc = [
     "ansys-sphinx-theme==0.16.6",
@@ -64,10 +65,12 @@ Releases = "https://github.com/ansys/allie-flowkit-python/releases/"
 [project.scripts]
 allie-flowkit-python = "allie.flowkit.__main__:main"
 
-
 [tool.flit.module]
 name = "allie.flowkit"
 
+[tool.pytest.ini_options]
+addopts = "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
+
 [tool.codespell]
 skip = "*.pyc,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac"
 
@@ -120,5 +123,3 @@ convention = "google"
 [tool.setuptools.packages.find]
 include = ["app", "docker", "configs"]
 
-[tool.pytest.ini_options]
-addopts = "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
\ No newline at end of file

From b21491bf1b2748a723b12ba28f5cda68ab44b440 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Wed, 7 Aug 2024 10:28:46 +0200
Subject: [PATCH 28/35] fix: pytest folder struct

---
 pyproject.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 7aace36..600e993 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -69,7 +69,7 @@ allie-flowkit-python = "allie.flowkit.__main__:main"
 name = "allie.flowkit"
 
 [tool.pytest.ini_options]
-addopts = "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
+addopts = "--cov=allie.flowkit --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
 
 [tool.codespell]
 skip = "*.pyc,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac"

From 352896a9cdbf07e60017623441c09db3388b911c Mon Sep 17 00:00:00 2001
From: Alex Fernandez <21alex295@gmail.com>
Date: Mon, 12 Aug 2024 09:01:27 +0200
Subject: [PATCH 29/35] Apply suggestions from code review

Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
---
 .github/labeler.yml           | 2 +-
 .github/workflows/ci_cd.yml   | 6 ++----
 doc/Makefile                  | 2 +-
 doc/source/conf.py            | 2 +-
 pyproject.toml                | 1 -
 src/allie/flowkit/__init__.py | 2 +-
 6 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/.github/labeler.yml b/.github/labeler.yml
index c026167..f63ba2e 100644
--- a/.github/labeler.yml
+++ b/.github/labeler.yml
@@ -4,7 +4,7 @@ documentation:
 
 maintenance:
 - changed-files:
-  - any-glob-to-any-file: ['.github/**/*', 'pyproject.toml', 'tox.ini', '.pre-commit-config.yaml']
+  - any-glob-to-any-file: ['.github/**/*', 'pyproject.toml', '.pre-commit-config.yaml']
 
 testing:
 - changed-files:
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index 6bc0ce6..3ef5879 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -9,7 +9,7 @@ on:
 
 env:
   MAIN_PYTHON_VERSION: '3.12'
-  DOCUMENTATION_CNAME: allie-flowkit-python.docs.pyansys.com
+  DOCUMENTATION_CNAME: expert-adventure-nvnoo1y.pages.github.io
   PACKAGE_NAME: allie-flowkit-python
 
 concurrency:
@@ -54,7 +54,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@v6
+        uses: ansys/actions/doc-style@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -63,8 +63,6 @@ jobs:
     runs-on: ubuntu-latest
     needs: [docs-style]
     steps:
-    - name: Setup headless display
-      uses: pyvista/setup-headless-display-action@v2
 
     - name: "Run Ansys documentation building action"
       uses: ansys/actions/doc-build@v6
diff --git a/doc/Makefile b/doc/Makefile
index d922f9f..0b56ba1 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    = -j auto -W --color
 SPHINXBUILD   = sphinx-build
 APIDIR        = api
-EXAMPLESDIR        = examples
+EXAMPLESDIR  = examples
 SOURCEDIR     = source
 BUILDDIR      = _build
 
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 2670545..a41107e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -24,7 +24,7 @@
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "ANSYS, Inc."
 release = version = __version__
-cname = os.getenv("DOCUMENTATION_CNAME", default="allie-flowkit-python.docs.pyansys.com")
+cname = os.getenv("DOCUMENTATION_CNAME", default="expert-adventure-nvnoo1y.pages.github.io")
 switcher_version = get_version_match(__version__)
 
 # Select desired logo, theme, and declare the html title
diff --git a/pyproject.toml b/pyproject.toml
index 600e993..8ea6534 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -29,7 +29,6 @@ dependencies = [
     "python_pptx >= 0.6.23,<1",
     "PyYAML >= 6.0.1,<7",
     "httpx >= 0.27.0",
-
 ]
 
 [project.optional-dependencies]
diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
index 638e0e3..e708200 100644
--- a/src/allie/flowkit/__init__.py
+++ b/src/allie/flowkit/__init__.py
@@ -23,6 +23,6 @@
 """App package responsible for creating the FastAPI app."""
 import importlib.metadata as importlib_metadata
 
-__version__ = importlib_metadata.version(__name__.replace(".", "-") + "-python")
+__version__ = importlib_metadata.version("allie-flowkit-python")
 
 from allie.flowkit.flowkit_service import flowkit_service  # noqa F401

From 7a8b2e1a7ef29e17e8e18cbd27a3e774e6a5ff65 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Mon, 12 Aug 2024 10:57:05 +0200
Subject: [PATCH 30/35] fix: Comments

---
 .github/workflows/ci_cd.yml             |  2 +-
 .pre-commit-config.yaml                 |  9 ++--
 doc/Makefile                            |  2 -
 doc/source/conf.py                      | 72 +++++++++----------------
 doc/source/index.rst                    |  2 +-
 docker/Dockerfile                       |  2 +-
 pyproject.toml                          |  6 +--
 src/allie/flowkit/__init__.py           |  1 +
 src/allie/flowkit/__main__.py           |  8 +--
 src/allie/flowkit/config/__init__.py    |  2 +-
 src/allie/flowkit/config/_config.py     |  2 +
 src/allie/flowkit/endpoints/splitter.py | 17 ++----
 src/allie/flowkit/fastapi_utils.py      | 27 +++++-----
 src/allie/flowkit/flowkit_service.py    |  7 ++-
 src/allie/flowkit/models/functions.py   |  9 ++--
 src/allie/flowkit/models/splitter.py    |  3 +-
 tests/conftest.py                       |  1 +
 tests/test_endpoints_splitter.py        |  5 +-
 tests/test_list_functions.py            |  1 +
 19 files changed, 73 insertions(+), 105 deletions(-)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index 6bc0ce6..684ff61 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -121,7 +121,7 @@ jobs:
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [code-style]
+    needs: [docs-build, tests]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 59dcd7a..074ca48 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -6,7 +6,7 @@ repos:
     additional_dependencies: [black==23.12.1]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v4.6.0
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
@@ -14,19 +14,20 @@ repos:
   - id: trailing-whitespace
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.27.3
+  rev: 0.29.1
   hooks:
     - id: check-github-workflows
 
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.5.5
+  rev: v0.5.7
   hooks:
     - id: ruff
       args: [--fix]
+    - id: ruff-format
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.3.1
+  rev: v0.4.3
   hooks:
     - id: add-license-headers
       files: '(src|examples|tests|docker)/.*\.(py)|\.(proto)'
diff --git a/doc/Makefile b/doc/Makefile
index d922f9f..30c1bb1 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -33,6 +33,4 @@ pdf:
 
 # Build HTML files and generate examples as .py files
 html:
-	pip uninstall vtk -y
-	pip install --extra-index-url https://wheels.vtk.org vtk-osmesa
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 2670545..317042e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -2,17 +2,14 @@
 
 from datetime import datetime
 import os
-from pathlib import Path
 
 from allie.flowkit import __version__
 from ansys_sphinx_theme import (
     ansys_favicon,
     ansys_logo_white,
     ansys_logo_white_cropped,
-    get_autoapi_templates_dir_relative_path,
     get_version_match,
     latex,
-    pyansys_logo_black,
     watermark,
 )
 from sphinx.builders.latex import LaTeXBuilder
@@ -28,7 +25,6 @@
 switcher_version = get_version_match(__version__)
 
 # Select desired logo, theme, and declare the html title
-html_logo = pyansys_logo_black
 html_theme = "ansys_sphinx_theme"
 html_short_title = html_title = "Allie Flowkit Python"
 html_baseurl = f"https://{cname}/version/stable"
@@ -41,6 +37,7 @@
     "doc_path": "doc/source",
 }
 html_theme_options = {
+    "logo": "pyansys",
     "switcher": {
         "json_url": f"https://{cname}/versions.json",
         "version_match": switcher_version,
@@ -65,9 +62,29 @@
             "url": f"https://{cname}/version/{switcher_version}/_static/assets/download/allie-flowkit-python.pdf",  # noqa: E501
             "icon": "fa fa-file-pdf fa-fw",
         },
-    ]
+    ],
+    "ansys_sphinx_theme_autoapi": {
+        "project": "Allie Flowkit Python",
+        "output": "api",
+        "use_implicit_namespaces": True,
+        "directory": "src",
+        "keep_files": True,
+        "own_page_level": "class",
+        "type": "python",
+        "options": [
+            "members",
+            "undoc-members",
+            "show-inheritance",
+            "show-module-summary",
+            "special-members",
+        ],
+        "class_content": "class",
+    },
 }
 
+suppress_warnings = ["autoapi.python_import_resolution", "design.grid", "config.cache", "autoapi.not_readable"]
+
+
 # Sphinx extensions
 extensions = [
     "sphinx.ext.intersphinx",
@@ -76,6 +93,7 @@
     "sphinx_jinja",
     "autoapi.extension",
     "numpydoc",
+    "ansys_sphinx_theme.extension.autoapi",
 ]
 
 nbsphinx_execute = "always"
@@ -148,46 +166,6 @@
 # The master toctree document.
 master_doc = "index"
 
-# Configuration for Sphinx autoapi
-autoapi_type = "python"
-autoapi_dirs = ["../../src"]
-autoapi_root = "api"
-autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__))
-suppress_warnings = ["autoapi.python_import_resolution", "design.grid", "config.cache",  "autoapi.not_readable"]
-autoapi_python_use_implicit_namespaces = True
-autoapi_keep_files = True
-autoapi_own_page_level = "class"
-autoapi_add_toctree_entry = False
-# Examples gallery customization
-nbsphinx_execute = "always"
-
-nbsphinx_epilog = """
-----
-
-.. admonition:: Download this example
-
-    Download this example as a `Jupyter Notebook <{cname_pref}/{ipynb_file_loc}>`_
-    or as a `Python script <{cname_pref}/{py_file_loc}>`_.
-
-""".format(
-    cname_pref=f"https://{cname}/version/{switcher_version}",
-    ipynb_file_loc="{{ env.docname }}.ipynb",
-    py_file_loc="{{ env.docname }}.py",
-)
-
-nbsphinx_prolog = """
-
-.. admonition:: Download this example
-
-    Download this example as a `Jupyter Notebook <{cname_pref}/{ipynb_file_loc}>`_
-    or as a `Python script <{cname_pref}/{py_file_loc}>`_.
-
-----
-""".format(
-    cname_pref=f"https://{cname}/version/{switcher_version}",
-    ipynb_file_loc="{{ env.docname }}.ipynb",
-    py_file_loc="{{ env.docname }}.py",
-)
 
 typehints_defaults = "comma"
 simplify_optional_unions = False
@@ -200,9 +178,7 @@
 latex_elements = {"preamble": latex.generate_preamble(html_title)}
 
 linkcheck_exclude_documents = ["index", "getting_started/local/index", "assets"]
-linkcheck_ignore = [
-    "https://github.com/ansys/allie-flowkit-python/"
-]
+linkcheck_ignore = ["https://github.com/ansys/allie-flowkit-python/"]
 # -- Declare the Jinja context -----------------------------------------------
 exclude_patterns = [
     "examples/**/*.ipynb",
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 6ffa99c..f2d2f4e 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -65,7 +65,7 @@ The Allie Flowkit Python offers these main features:
        getting_started/index
        user_guide/index
        {% if build_api %}
-       api/src/allie/flowkit/index
+       api/index
        {% endif %}
        {% if build_examples %}
        examples/index
diff --git a/docker/Dockerfile b/docker/Dockerfile
index df4e4f5..c3bbea1 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -7,7 +7,7 @@ COPY app/ ./src/allie/flowkit/
 COPY configs/config.yaml .
 
 # Install dependencies
-RUN pip install --no-cache-dir .
+RUN pip install --no-cache-dir .[all]
 
 EXPOSE 8000
 
diff --git a/pyproject.toml b/pyproject.toml
index 600e993..ccc4e26 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -43,10 +43,7 @@ tests = [
     "pytest-asyncio >= 0.23.8,<1",
 ]
 doc = [
-    "ansys-sphinx-theme==0.16.6",
-    "jupyter_sphinx==0.5.3",
-    "jupytext==1.16.4",
-    "nbsphinx==0.9.4",
+    "ansys-sphinx-theme==1.0.3",
     "numpydoc==1.7.0",
     "sphinx==8.0.2",
     "sphinx-autoapi==3.2.1",
@@ -108,7 +105,6 @@ ignore = ["D416"]
 
 [tool.ruff.format]
 quote-style = "double"
-indent-style = "tab"
 line-ending = "auto"
 
 [tool.ruff.lint.isort]
diff --git a/src/allie/flowkit/__init__.py b/src/allie/flowkit/__init__.py
index 638e0e3..b077dcc 100644
--- a/src/allie/flowkit/__init__.py
+++ b/src/allie/flowkit/__init__.py
@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 """App package responsible for creating the FastAPI app."""
+
 import importlib.metadata as importlib_metadata
 
 __version__ = importlib_metadata.version(__name__.replace(".", "-") + "-python")
diff --git a/src/allie/flowkit/__main__.py b/src/allie/flowkit/__main__.py
index 4d3ca42..66f5f9c 100644
--- a/src/allie/flowkit/__main__.py
+++ b/src/allie/flowkit/__main__.py
@@ -21,23 +21,23 @@
 # SOFTWARE.
 
 """Main module for the FlowKit service."""
+
 try:
     import uvicorn
 except ImportError:
-    raise ImportError(
-        "Please install uvicorn to run the service: pip install allie-flowkit-python[all]"
-    )
+    raise ImportError("Please install uvicorn to run the service: pip install allie-flowkit-python[all]")
 import argparse
 
 
 def main():
     """Run entrypoint for the FlowKit service."""
-    parse  = argparse.ArgumentParser()
+    parse = argparse.ArgumentParser()
     parse.add_argument("--host", type=str, default="0.0.0.0", help="The host to run the service on. By default 0.0.0.0")
     parse.add_argument("--port", type=int, default=8000, help="The port to run the service on. By default 8000")
     parse.add_argument("--workers", type=int, default=4, help="The number of workers to use. By default 4")
     args = parse.parse_args()
     uvicorn.run("allie.flowkit:flowkit_service", host=args.host, port=args.port, workers=args.workers)
 
+
 if __name__ == "__main__":
     main()
diff --git a/src/allie/flowkit/config/__init__.py b/src/allie/flowkit/config/__init__.py
index 86b793f..c8f8f09 100644
--- a/src/allie/flowkit/config/__init__.py
+++ b/src/allie/flowkit/config/__init__.py
@@ -22,4 +22,4 @@
 
 """Configuration package for the application."""
 
-from allie.flowkit.config._config import CONFIG # noqa F401
+from allie.flowkit.config._config import CONFIG  # noqa F401
diff --git a/src/allie/flowkit/config/_config.py b/src/allie/flowkit/config/_config.py
index 612d6c1..de35ec7 100644
--- a/src/allie/flowkit/config/_config.py
+++ b/src/allie/flowkit/config/_config.py
@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 """Module for reading the configuration settings from a YAML file."""
+
 import os
 from pathlib import Path
 
@@ -97,5 +98,6 @@ def _load_config(self, config_path: str) -> dict:
                 except FileNotFoundError:
                     raise FileNotFoundError("Configuration file not found at the default location.")
 
+
 # Initialize the config object
 CONFIG = Config()
diff --git a/src/allie/flowkit/endpoints/splitter.py b/src/allie/flowkit/endpoints/splitter.py
index 3f853b8..b94826e 100644
--- a/src/allie/flowkit/endpoints/splitter.py
+++ b/src/allie/flowkit/endpoints/splitter.py
@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 """Module for splitting text into chunks."""
+
 import base64
 import io
 
@@ -131,9 +132,7 @@ def process_ppt(request: SplitterRequest) -> SplitterResponse:
     if not ppt_text:
         raise HTTPException(status_code=400, detail="No text found in PowerPoint document")
 
-    splitter = RecursiveCharacterTextSplitter(
-        chunk_size=request.chunk_size, chunk_overlap=request.chunk_overlap
-    )
+    splitter = RecursiveCharacterTextSplitter(chunk_size=request.chunk_size, chunk_overlap=request.chunk_overlap)
     chunks = splitter.split_text(ppt_text)
     response = SplitterResponse(chunks=chunks)
 
@@ -165,9 +164,7 @@ def process_python_code(request: SplitterRequest) -> SplitterResponse:
     except UnicodeDecodeError:
         raise HTTPException(status_code=400, detail="Error decoding Python code")
 
-    splitter = PythonCodeTextSplitter(
-        chunk_size=request.chunk_size, chunk_overlap=request.chunk_overlap
-    )
+    splitter = PythonCodeTextSplitter(chunk_size=request.chunk_size, chunk_overlap=request.chunk_overlap)
     chunks = splitter.split_text(document_content_str)
     response = SplitterResponse(chunks=chunks)
 
@@ -206,9 +203,7 @@ def process_pdf(request: SplitterRequest) -> SplitterResponse:
     if not pdf_text:
         raise HTTPException(status_code=400, detail="No text found in PDF document")
 
-    splitter = RecursiveCharacterTextSplitter(
-        chunk_size=request.chunk_size, chunk_overlap=request.chunk_overlap
-    )
+    splitter = RecursiveCharacterTextSplitter(chunk_size=request.chunk_size, chunk_overlap=request.chunk_overlap)
     chunks = splitter.split_text(pdf_text)
     response = SplitterResponse(chunks=chunks)
 
@@ -250,6 +245,4 @@ def validate_request(request: SplitterRequest, api_key: str):
 
     # Check if chunk overlap is greater than or equal to 0
     if request.chunk_overlap < 0:
-        raise HTTPException(
-            status_code=400, detail="Chunk overlap must be greater than or equal to 0"
-        )
+        raise HTTPException(status_code=400, detail="Chunk overlap must be greater than or equal to 0")
diff --git a/src/allie/flowkit/fastapi_utils.py b/src/allie/flowkit/fastapi_utils.py
index e1f7a97..195604e 100644
--- a/src/allie/flowkit/fastapi_utils.py
+++ b/src/allie/flowkit/fastapi_utils.py
@@ -21,8 +21,9 @@
 # SOFTWARE.
 
 """Utils module for FastAPI related operations."""
+
 import inspect
-from typing import Any, Dict, List, Type, get_type_hints
+from typing import Any, get_type_hints
 
 from allie.flowkit.models.functions import EndpointInfo, ParameterInfo
 from fastapi.routing import APIRoute
@@ -110,12 +111,12 @@ def get_parameters_info(params: dict):
     return parameters_info
 
 
-def get_return_type_info(return_type: Type[BaseModel]):
+def get_return_type_info(return_type: type[BaseModel]):
     """Get return type information from the function's return type.
 
     Parameters
     ----------
-    return_type : Type[BaseModel]
+    return_type : type[BaseModel]
         The return type of the function.
 
     Returns
@@ -130,7 +131,7 @@ def get_return_type_info(return_type: Type[BaseModel]):
     return [ParameterInfo(name="return", type=str(return_type.__name__))]
 
 
-def extract_definitions_from_schema(schema: dict) -> Dict[str, Any]:
+def extract_definitions_from_schema(schema: dict) -> dict[str, Any]:
     """Extract definitions from a schema.
 
     Parameters
@@ -148,7 +149,7 @@ def extract_definitions_from_schema(schema: dict) -> Dict[str, Any]:
     return definitions
 
 
-def get_definitions_from_params(params: dict) -> Dict[str, Any]:
+def get_definitions_from_params(params: dict) -> dict[str, Any]:
     """Get definitions from function parameters.
 
     Parameters
@@ -170,12 +171,12 @@ def get_definitions_from_params(params: dict) -> Dict[str, Any]:
     return definitions
 
 
-def get_definitions_from_return_type(return_type: Type[BaseModel]) -> Dict[str, Any]:
+def get_definitions_from_return_type(return_type: type[BaseModel]) -> dict[str, Any]:
     """Get definitions from the function's return type.
 
     Parameters
     ----------
-    return_type : Type[BaseModel]
+    return_type : type[BaseModel]
         The return type of the function.
 
     Returns
@@ -190,16 +191,14 @@ def get_definitions_from_return_type(return_type: Type[BaseModel]) -> Dict[str,
     return {}
 
 
-def extract_endpoint_info(
-    function_map: Dict[str, Any], routes: List[APIRoute]
-) -> List[EndpointInfo]:
+def extract_endpoint_info(function_map: dict[str, Any], routes: list[APIRoute]) -> list[EndpointInfo]:
     """Extract endpoint information from the given routes.
 
     Parameters
     ----------
-    function_map : Dict[str, Any]
+    function_map : dict[str, Any]
         A dictionary mapping function names to their implementations.
-    routes : List[APIRoute]
+    routes : list[APIRoute]
         A list of APIRoute objects representing the API routes.
 
     Returns
@@ -220,9 +219,7 @@ def extract_endpoint_info(
 
                 # Get definitions from both inputs and outputs
                 input_definitions = get_definitions_from_params(signature.parameters)
-                output_definitions = (
-                    get_definitions_from_return_type(return_type) if return_type else {}
-                )
+                output_definitions = get_definitions_from_return_type(return_type) if return_type else {}
                 definitions = {**input_definitions, **output_definitions}
 
                 endpoint_info = EndpointInfo(
diff --git a/src/allie/flowkit/flowkit_service.py b/src/allie/flowkit/flowkit_service.py
index 79f2e34..afd970d 100644
--- a/src/allie/flowkit/flowkit_service.py
+++ b/src/allie/flowkit/flowkit_service.py
@@ -21,7 +21,6 @@
 # SOFTWARE.
 
 """Module for the Allie Flowkit service."""
-from typing import List
 
 from allie.flowkit.config._config import CONFIG
 from allie.flowkit.endpoints import splitter
@@ -43,8 +42,8 @@
 
 
 # Endpoint to list all enpoint information
-@flowkit_service.get("/", response_model=List[EndpointInfo])
-async def list_functions(api_key: str = Header(...)) -> List[EndpointInfo]:
+@flowkit_service.get("/", response_model=list[EndpointInfo])
+async def list_functions(api_key: str = Header(...)) -> list[EndpointInfo]:
     """List all available functions and their endpoints.
 
     Parameters
@@ -54,7 +53,7 @@ async def list_functions(api_key: str = Header(...)) -> List[EndpointInfo]:
 
     Returns
     -------
-    List[EndpointInfo]
+    list[EndpointInfo]
         A list of EndpointInfo objects representing the endpoints.
 
     """
diff --git a/src/allie/flowkit/models/functions.py b/src/allie/flowkit/models/functions.py
index 9d3a380..d844934 100644
--- a/src/allie/flowkit/models/functions.py
+++ b/src/allie/flowkit/models/functions.py
@@ -21,7 +21,8 @@
 # SOFTWARE.
 
 """Module for defining the models used in the endpoints."""
-from typing import Any, Dict, List
+
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -52,6 +53,6 @@ class EndpointInfo(BaseModel):
 
     name: str
     path: str
-    inputs: List[ParameterInfo]
-    outputs: List[ParameterInfo]
-    definitions: Dict[str, Any]
+    inputs: list[ParameterInfo]
+    outputs: list[ParameterInfo]
+    definitions: dict[str, Any]
diff --git a/src/allie/flowkit/models/splitter.py b/src/allie/flowkit/models/splitter.py
index 36225d2..c074f4e 100644
--- a/src/allie/flowkit/models/splitter.py
+++ b/src/allie/flowkit/models/splitter.py
@@ -21,7 +21,6 @@
 # SOFTWARE.
 
 """Model for the splitter endpoint."""
-from typing import List
 
 from pydantic import BaseModel
 
@@ -51,4 +50,4 @@ class SplitterResponse(BaseModel):
 
     """
 
-    chunks: List[str]
+    chunks: list[str]
diff --git a/tests/conftest.py b/tests/conftest.py
index ee67eaf..4d2e66c 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Module for test helper functions."""
+
 from unittest.mock import patch
 
 import pytest
diff --git a/tests/test_endpoints_splitter.py b/tests/test_endpoints_splitter.py
index 9634533..32f26b8 100644
--- a/tests/test_endpoints_splitter.py
+++ b/tests/test_endpoints_splitter.py
@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Test module for the splitter endpoints."""
+
 import base64
 from pathlib import Path
 
@@ -92,7 +93,9 @@ async def test_split_pdf():
     # Test case 1: valid request
     (
         SplitterRequest(
-            document_content="dGVzdA==", chunk_size=100, chunk_overlap=10  # base64 for "test"
+            document_content="dGVzdA==",
+            chunk_size=100,
+            chunk_overlap=10,  # base64 for "test"
         ),
         MOCK_API_KEY,
         None,
diff --git a/tests/test_list_functions.py b/tests/test_list_functions.py
index a6d791d..94202f9 100644
--- a/tests/test_list_functions.py
+++ b/tests/test_list_functions.py
@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Test module for list functions."""
+
 from allie.flowkit import flowkit_service
 from fastapi.testclient import TestClient
 import pytest

From c3056e743b7ded0a94ddda61fc47990cae83da69 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Mon, 12 Aug 2024 11:12:10 +0200
Subject: [PATCH 31/35] fix: Contributing docs

---
 CONTRIBUTING.md             | 76 +++----------------------------------
 doc/source/contributing.rst | 70 ++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+), 71 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 63c2749..86cfed2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,76 +1,10 @@
 # Contribute
 
 Overall guidance on contributing to a PyAnsys library appears in the
-[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
+*Contributing* topic in the *[PyAnsys developer's guide]*. Ensure that you
 are thoroughly familiar with this guide before attempting to contribute to
-allie-flowkit-python.
+allie-flowkit-python. For contributing to this project, please refer to the
+[Contributing] section of this project's documentation.
 
-The following contribution information is specific to *Allie Flowkit Python*.
-
-[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
-
-## Clone the repository
-
-To clone and install the latest *Allie Flowkit Python* release in development mode, run
-these commands:
-
-```bash
-git clone https://github.com/ansys/allie-flowkit-python/
-cd allie-flowkit-python
-python -m pip install --upgrade pip
-pip install -e .
-```
-
-## Adhere to code style
-
-*Allie Flowkit Python* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
-
-To ensure your code meets minimum code styling standards, run these commands:
-
-```bash
-pip install pre-commit
-pre-commit run --all-files
-```
-
-You can also install this as a pre-commit hook by running this command:
-
-```bash
-pre-commit install
-```
-
-## Run the tests
-
-Prior to running the tests, you must run this command to install the test dependencies:
-
-```bash
-pip install -e .[tests]
-```
-
-To run the tests, navigate to the root directory of the repository and run this command:
-
-```bash
-pytest
-```
-
-
-## Build the documentation
-
-Prior to building the documentation, you must run this command to install the documentation dependencies:
-
-```bash
-pip install -e .[doc]
-```
-
-To build the documentation, run the following commands:
-
-```bash
-cd doc
-
-# On linux
-make html
-
-# On windows
-./make.bat html
-```
-
-The documentation is built in the `docs/_build/html` directory.
+[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html
+[Contributing]: expert-adventure-nvnoo1y.pages.github.io/dev/contributing.html
\ No newline at end of file
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 828645c..eb27025 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -9,3 +9,73 @@ in the *PyAnsys developer's guide*. Ensure that you are thoroughly familiar
 with this guide before attempting to contribute to the Allie Flowkit Python.
 
 The following contribution information is specific to the Allie Flowkit Python.
+
+
+Clone the repository
+--------------------
+
+To clone and install the latest *Allie Flowkit Python* release in development mode, run
+these commands:
+
+.. code::
+
+    git clone https://github.com/ansys/allie-flowkit-python/
+    cd allie-flowkit-python
+    python -m pip install --upgrade pip
+    pip install -e .
+
+Adhere to code style
+--------------------
+
+*Allie Flowkit Python* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
+
+To ensure your code meets minimum code styling standards, run these commands:
+
+.. code::
+
+    pip install pre-commit
+    pre-commit run --all-files
+
+You can also install this as a pre-commit hook by running this command:
+
+.. code::
+
+    pre-commit install
+
+Run the tests
+-------------
+
+Prior to running the tests, you must run this command to install the test dependencies:
+
+.. code::
+
+    pip install -e .[tests]
+
+To run the tests, navigate to the root directory of the repository and run this command:
+
+.. code::
+
+    pytest
+
+Build the documentation
+-----------------------
+
+Prior to building the documentation, you must run this command to install the documentation dependencies:
+
+.. code::
+
+    pip install -e .[doc]
+
+To build the documentation, run the following commands:
+
+.. code::
+
+    cd doc
+
+    # On linux
+    make html
+
+    # On windows
+    ./make.bat html
+
+The documentation is built in the `docs/_build/html` directory.

From f0a9173261888c36472c6fc4919ff77bb2a1d29c Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Mon, 12 Aug 2024 11:14:09 +0200
Subject: [PATCH 32/35] fix: Remove packaging from CICD

---
 .github/workflows/ci_cd.yml | 14 +-------------
 1 file changed, 1 insertion(+), 13 deletions(-)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index bc8f896..e461bd3 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -69,22 +69,11 @@ jobs:
       with:
         add-pdf-html-docs-as-assets: true
 
-  package:
-    name: Package library
-    needs: [docs-build, smoke-tests]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v6
-        with:
-          library-name: ${{ env.PACKAGE_NAME }}
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
-
   upload_dev_docs:
     name: Upload dev documentation
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
-    needs: [package]
+    needs: [docs-build]
     steps:
       - name: Deploy the latest documentation
         uses: ansys/actions/doc-deploy-dev@v6
@@ -92,7 +81,6 @@ jobs:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
-
   tests:
     name: "Tests"
     runs-on: ${{ matrix.os }}

From 950e75cd39f95858aeab5162feb777145d605c26 Mon Sep 17 00:00:00 2001
From: Alex Fernandez <21alex295@gmail.com>
Date: Mon, 12 Aug 2024 11:44:35 +0200
Subject: [PATCH 33/35] Update doc/source/index.rst

Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
---
 doc/source/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/source/index.rst b/doc/source/index.rst
index f2d2f4e..f0a65b3 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,5 +1,5 @@
 Allie Flowkit Python documentation |version|
-====================================================
+=============================================
 
 The Allie Flowkit Python is a Python service that exposes features from Allie Flowkit to Python users. This documentation provides information on how to install and use the Allie Flowkit Python.
 

From 4dabd1a279f382945c11ed2d68ae4a87c3c83892 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Mon, 12 Aug 2024 11:47:55 +0200
Subject: [PATCH 34/35] fix: Update ansys actions

---
 .github/workflows/ci_cd.yml | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
index e461bd3..36a385c 100644
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Run PyAnsys code style checks"
-        uses: ansys/actions/code-style@v6
+        uses: ansys/actions/code-style@v7
 
   smoke-tests:
     name: Build and Smoke tests
@@ -43,7 +43,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v6
+        uses: ansys/actions/build-wheelhouse@v7
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           operating-system: ${{ matrix.os }}
@@ -65,7 +65,7 @@ jobs:
     steps:
 
     - name: "Run Ansys documentation building action"
-      uses: ansys/actions/doc-build@v6
+      uses: ansys/actions/doc-build@v7
       with:
         add-pdf-html-docs-as-assets: true
 
@@ -76,7 +76,7 @@ jobs:
     needs: [docs-build]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v6
+        uses: ansys/actions/doc-deploy-dev@v7
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -93,7 +93,7 @@ jobs:
     steps:
 
       - name: Testing
-        uses: ansys/actions/tests-pytest@v6
+        uses: ansys/actions/tests-pytest@v7
         timeout-minutes: 12
 
       - name: Upload coverage results (HTML)
@@ -125,7 +125,7 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v6
+        uses: ansys/actions/doc-deploy-stable@v7
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}

From 185d1a25f00255025faa1748fdb633986de78848 Mon Sep 17 00:00:00 2001
From: afernand <alex.fernandezluces@ansys.com>
Date: Mon, 12 Aug 2024 13:18:20 +0200
Subject: [PATCH 35/35] fix: Dockerfile and readme

---
 README.md         | 32 ++++++++++++++++----------------
 docker/Dockerfile |  9 +++++++--
 2 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 1ad9973..34a6ab8 100644
--- a/README.md
+++ b/README.md
@@ -93,27 +93,27 @@ Allie FlowKit Python can be run locally or as a Docker container. Follow the ins
 ## Adding custom functions
 
 1. **Create a New Function:**
-   - Add your function code as an endpoint to a new Python file in the `app/endpoints` directory.
-   - Use the `app/endpoints/splitter.py` file and its endpoints as an example.
+   - Add your function code as an endpoint to a new Python file in the `allie/flowkit/endpoints` directory.
+   - Use the `allie/flowkit/endpoints/splitter.py` file and its endpoints as an example.
    - Explicitly define the input and output of the function using Pydantic models, as these will be used by the Allie Agent to call the function.
 
 2. **Add the models for the function:**
-   - Create the models for the input and output of the function in the `app/models` directory.
-   - Use the `app/models/splitter.py` file and its models as an example.
+   - Create the models for the input and output of the function in the `allie/flowkit/models` directory.
+   - Use the `allie/flowkit/models/splitter.py` file and its models as an example.
 
 3. **Add the endpoints to the service:**
-   - Import your module in the `app/app.py` file and add the router to the service.
+   - Import your module in the `allie/flowkit/flowkit_service.py` file and add the router to the service.
 
 4. **Add the function to the function map:**
-    - Add your function to the `function_map` dictionary in the `app/app.py` file.
+    - Add your function to the `function_map` dictionary in the `allie/flowkit/flowkit_service.py` file.
 
 ### Example´
 
 1. **Create a new file for all your custom functions:**
-- In the `app/endpoints` directory, create a new Python file named `custom_endpoint.py`.
+- In the `allie/flowkit/endpoints` directory, create a new Python file named `custom_endpoint.py`.
 
 2. **Create the models for the custom function:**
-- In the `app/models` directory, create a new Python file named `custom_model.py`.
+- In the `allie/flowkit/models` directory, create a new Python file named `custom_model.py`.
 
     **custom_model.py**:
     ```python
@@ -152,7 +152,7 @@ Allie FlowKit Python can be run locally or as a Docker container. Follow the ins
     **custom_endpoint.py**:
     ```python
     from fastapi import FastAPI, APIRouter
-    from app.models.custom_model import CustomRequest, CustomResponse
+    from allie.flowkit.models.custom_model import CustomRequest, CustomResponse
 
 
     @router.post("/custom_function", response_model=CustomResponse)
@@ -176,22 +176,22 @@ Allie FlowKit Python can be run locally or as a Docker container. Follow the ins
     ```
 
 4. **Import the module and add the router to the service:**
-- Import the module in the ``app/app.py`` file and add the router to the service.
+- Import the module in the ``allie/flowkit/flowkit_service.py`` file and add the router to the service.
 
-    **app.py**:
+    **flowkit_service.py**:
     ```python
-    from app.endpoints import custom_endpoint
+    from allie.flowkit.endpoints import custom_endpoint
 
-    app.include_router(splitter.router, prefix="/splitter", tags=["splitter"])
-    app.include_router(
+    flowkit_servie.include_router(splitter.router, prefix="/splitter", tags=["splitter"])
+    flowkit_servie.include_router(
         custom_endpoint.router, prefix="/custom_endpoint", tags=["custom_endpoint"]
     )
     ```
 
 5. **Add the function to the function map:**
-- Add your function to the ``function_map`` dictionary in the ``app/app.py`` file.
+- Add your function to the ``function_map`` dictionary in the ``allie/flowkit/flowkit_service.py`` file.
 
-    **app.py**:
+    **flowkit_service.py**:
     ```python
     function_map = {
         "split_ppt": splitter.split_ppt,
diff --git a/docker/Dockerfile b/docker/Dockerfile
index c3bbea1..86c48bc 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -3,10 +3,15 @@ FROM python:3.12-slim
 WORKDIR /app
 
 # Copy the app folder and the config.yaml file
-COPY app/ ./src/allie/flowkit/
-COPY configs/config.yaml .
+COPY src /app
+
+# readme required by pip
+COPY README.md /app
+COPY pyproject.toml /app
+COPY configs/config.yaml /app
 
 # Install dependencies
+RUN echo $(ls)
 RUN pip install --no-cache-dir .[all]
 
 EXPOSE 8000