Project compliance (#270)

* Shift pyproject.toml

Author: gotsysdba

.dockerignore

@@ -0,0 +1,24 @@
+## Copyright (c) 2024, 2025, Oracle and/or its affiliates.
+## Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+
+# Ignore everything
+**
+
+# Keep the src directory and pyproject.toml file
+!src/
+!pyproject.toml
+
+# Inside src, ignore specific things
+src/**/Dockerfile*
+src/**/__pycache__/
+src/**/.pytest_cache/
+src/**/tns_admin/
+src/**/.oci/
+src/**/.*
+src/**/*.sh
+src/**/*.log
+
+# But explicitly keep these
+!src/.streamlit
+!src/client/spring_ai/templates/env.sh
+!src/entrypoint.sh

.github/workflows/image_smoke.yml

@@ -26,14 +26,11 @@ jobs:
       matrix:
         build:
           - name: aio
-            dockerfile: Dockerfile
-            context: src
+            dockerfile: src/Dockerfile
           - name: client
-            dockerfile: client/Dockerfile
-            context: src
+            dockerfile: src/client/Dockerfile
           - name: server
-            dockerfile: server/Dockerfile
-            context: src
+            dockerfile: src/server/Dockerfile
 
     name: ${{ matrix.build.name }}
     steps:
@@ -58,17 +55,15 @@ jobs:
             docker buildx build \
               --cache-from=type=local,src=/tmp/.buildx-cache \
               --cache-to=type=local,dest=/tmp/.buildx-cache-new \
-              --file ${{ matrix.build.context }}/${{ matrix.build.dockerfile }} \
+              --file ${{ matrix.build.dockerfile }} \
               --tag ${{ matrix.build.name }}:${{ github.sha }} \
-              --load \
-              ${{ matrix.build.context }}
+              --load .
           else
             docker buildx build \
               --cache-from=type=local,src=/tmp/.buildx-cache \
               --cache-to=type=local,dest=/tmp/.buildx-cache-new \
-              --file ${{ matrix.build.context }}/${{ matrix.build.dockerfile }} \
-              --output=type=cacheonly \
-              ${{ matrix.build.context }}
+              --file ${{ matrix.build.dockerfile }} \
+              --output=type=cacheonly .
           fi
 
       - name: Move Cache for Reuse

.github/workflows/pytest.yml

@@ -48,10 +48,9 @@ jobs:
 
       - name: Install dependencies
         run: |
-          cd src/
-          python -m pip install --upgrade pip wheel setuptools
-          pip install torch==2.8.0+cpu -f https://download.pytorch.org/whl/cpu/torch
-          pip install -e ".[all-test]"
+          python -m pip install --upgrade pip wheel setuptools uv
+          uv pip install torch==2.8.0+cpu -f https://download.pytorch.org/whl/cpu/torch --system
+          uv pip install -e ".[all-test]" --system
 
       - name: Run All Tests
         run: pytest

.github/workflows/releases.yml

@@ -51,9 +51,8 @@ jobs:
 
       - name: Build and Push Source
         run: |
-          cd src
-          zip -r $RUNNER_TEMP/${{ env.SRC }}.zip .
-          tar -czf "$RUNNER_TEMP/${{ env.SRC }}.tar.gz" .
+          zip -r $RUNNER_TEMP/${{ env.SRC }}.zip src pyproject.toml .dockerignore
+          tar -czf "$RUNNER_TEMP/${{ env.SRC }}.tar.gz" src pyproject.toml .dockerignore
           gh release upload ${{github.event.release.tag_name}} "$RUNNER_TEMP/${{ env.SRC }}.zip" --clobber
           gh release upload ${{github.event.release.tag_name}} "$RUNNER_TEMP/${{ env.SRC }}.tar.gz" --clobber
         env:

.gitignore

@@ -39,7 +39,7 @@ __pycache__/
 .pytest_cache
 *.py[cod]
 *$py.class
-*/*.egg-info
+**/*.egg-info
 **/build/
 
 ##############################################################################

README.md

@@ -41,22 +41,21 @@ To run the application on bare-metal; download the [source](https://github.com/o
 1. Create and activate a Python Virtual Environment:
 
    ```bash
-   cd src/
    python3.11 -m venv .venv --copies
    source .venv/bin/activate
-   pip3.11 install --upgrade pip wheel setuptools
+   pip3.11 install --upgrade pip wheel setuptools uv
    ```
 
 1. Install the Python modules:
 
    ```bash
-   pip3.11 install -e ".[all]"
-   source .venv/bin/activate
+   uv pip install -e ".[all]"
    ```
 
 1. Start Streamlit:
 
    ```bash
+   cd src/
    streamlit run launch_client.py --server.port 8501
    ```
 
@@ -70,11 +69,10 @@ To run the application in a container; download the [source](https://github.com/
 
 1. Build the all-in-one image.
 
-   From the `src/` directory, build image:
+   _Note:_ MacOS Silicon users may need to specify `--arch amd64`
 
    ```bash
-   cd src/
-   podman build -t ai-optimizer-aio .
+   podman build -f src/Dockerfile -t ai-optimizer-aio .
    ```
 
 1. Start the Container:

docs/content/_index.md

@@ -69,13 +69,13 @@ To run the application on bare-metal, download the latest release:
    cd ai-optimizer
    python3.11 -m venv .venv
    source .venv/bin/activate
-   pip3.11 install --upgrade pip wheel
+   pip3.11 install --upgrade pip wheel uv
    ```
 
 1. Install the Python modules:
 
    ```bash
-    pip3.11 install -e ".[all]"
+   uv pip install -e ".[all]"
    ```
 
 1. Start Streamlit:
@@ -108,8 +108,10 @@ To run the application in a container, download the latest release:
 
 1. Build the *ai-optimizer-aio* image.
 
+   _Note:_ MacOS Silicon users may need to specify `--arch amd64`
+
    ```bash
-   podman build -t ai-optimizer-aio .
+   podman build -f src/Dockerfile -t ai-optimizer-aio .
    ```
 
 1. Start the Container:

docs/content/advanced/helm.md

@@ -39,12 +39,13 @@ You will need to build the {{< short_app_ref >}} container images and stage them
    ```
 
 1. Build the {{< short_app_ref >}} images:
+   
+   _Note:_ Depending on the Kubernetes worker node architecture, you may need to specify `--arch amd64` or `--arch aarm64`
 
-    From the code source `src/` directory:
     ```bash
-    podman build --arch amd64 -f client/Dockerfile -t ai-optimizer-client:latest .
+    podman build -f src/client/Dockerfile -t ai-optimizer-client:latest .
 
-    podman build --arch amd64 -f server/Dockerfile -t ai-optimizer-server:latest .
+    podman build -f src/server/Dockerfile -t ai-optimizer-server:latest .
     ```
 
 1. Tag the {{< short_app_ref >}} images:

docs/content/walkthrough/_index.md

@@ -145,9 +145,11 @@ The {{< short_app_ref >}} provides an easy to use front-end for experimenting wi
 
 1. Build the Container Image
 
+   _Note:_ MacOS Silicon users may need to specify `--arch amd64`
+
    ```bash
    cd ai-optimizer
-   podman build --arch amd64 -t localhost/ai-optimizer-aio:latest .
+   podman build -f src/Dockerfile -t localhost/ai-optimizer-aio:latest .
    ```
 
 1. Start the {{< short_app_ref >}}:

opentofu/modules/kubernetes/templates/k8s_manifest.yaml

@@ -136,7 +136,7 @@ spec:
             - --local
             - context=/workspace
             - --local
-            - dockerfile=/workspace/server
+            - dockerfile=/workspace/src/server
             - --output 
             - type=image,name=${repository_server}:latest,push=true
           securityContext:
@@ -172,7 +172,7 @@ spec:
             - --local
             - context=/workspace
             - --local
-            - dockerfile=/workspace/client
+            - dockerfile=/workspace/src/client
             - --output 
             - type=image,name=${repository_client}:latest,push=true
           securityContext: