Merge pull request #8 from Ottermatics/cicd

refactor for pypi

Author: SoundsSerious

.github/workflows/build.yml

@@ -19,31 +19,26 @@ on:
   workflow_dispatch:
   workflow_call:
 jobs:
-  test:
+  format:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [ "3.9", "3.10", "3.11" ]
-
+    if: github.event_name == 'pull_request'
+    permissions:
+      contents: write
     steps:
     - uses: actions/checkout@v4
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-
+        ref: ${{ github.head_ref || github.ref }}
+        
     - name: Install Python
       uses: actions/setup-python@v4
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: "3.11"
 
-    - name: Install dependencies
+    - name: Install Black
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest black
-        pip install -e .[all]    
-
-    - name: Display Python Version
-      run: python -c "import sys; print(sys.version)"
+        pip install black
 
     - name: Check for existing release
       if: github.event_name == 'pull_request'
@@ -63,23 +58,49 @@ jobs:
         else
           echo "Version v$VERSION is available"
         fi
-      env:
-        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Auto-format with Black
-      if: github.event_name == 'pull_request'
       run: |
         black ./engforge
         if ! git diff --quiet; then
           git config --local user.email "[email protected]"
           git config --local user.name "GitHub Action"
           git add -A
           git commit -m "Auto-format code with Black [skip ci]" || exit 0
-          git push
+          git push origin HEAD:${{ github.head_ref }}
         fi
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  test:
+    runs-on: ubuntu-latest
+    needs: [format]
+    if: always() && (needs.format.result == 'success' || needs.format.result == 'skipped')
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11" ]
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        ref: ${{ github.head_ref || github.ref }}
+
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
 
-    - name: Run tests
-      run: python -m unittest discover -s engforge/test -p "test_*.py" -v
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest black
+        pip install -e .[all]    
 
-    - name: Verify Black formatting
-      run: black --check --verbose ./engforge
+    - name: Check Python & Run Tests
+      run: |
+        python -c "import sys; print(sys.version)"
+        python -m pip list | grep PyNiteFEA || echo "pynite-not-found"
+        python -m pip list | grep coolprop || echo "coolprop-not-found"
+        python -m unittest discover -s engforge/test -p "test_*.py" -v

engforge/_testing_components.py

@@ -760,7 +760,7 @@ class Comp2(Norm, CostModel):
     comp1 = Slot.define(Comp1, none_ok=True, default_ok=False)
 
 
-quarterly = lambda inst, term: True if (term + 1) % 3 == 0 else False
+quarterly = lambda inst, term, econ: True if (term + 1) % 3 == 0 else False
 
 
 @forge

engforge/attr_plotting.py

@@ -1,5 +1,4 @@
-"""This module defines Plot and Trace methods that allow the plotting of Statistical & Transient relationships of data in each system
-"""
+"""This module defines Plot and Trace methods that allow the plotting of Statistical & Transient relationships of data in each system"""
 
 import attrs
 import uuid

engforge/attributes.py

@@ -1,6 +1,6 @@
 """Defines a customizeable attrs attribute that is handled in configuration,
 
-on init an instance of `Instance` type for any ATTR_BASE subclass is created """
+on init an instance of `Instance` type for any ATTR_BASE subclass is created"""
 
 import attrs, attr, uuid
 from engforge.logging import LoggingMixin, log

engforge/component_collections.py

@@ -1,12 +1,12 @@
 """define a collection of components that will propigate to its parents dataframe
 
-When `wide` is set each component's references are reported to the system's table, otherwise only one component's references are reported, however the system will iterate over the components by calling `system.iterable_components` 
+When `wide` is set each component's references are reported to the system's table, otherwise only one component's references are reported, however the system will iterate over the components by calling `system.iterable_components`
 
 Define a Iterable Component slot in a system by calling `Slot.define_iterable(...,wide=True/False)`
 
 CostModel isonly supported in wide mode at this time.
 
-Types: 
+Types:
 1. ComponentList, ordered by index
 2. ComponentDict, ordered by key
 3. ComponentGraph,  ?#TODO:

engforge/configuration.py

@@ -331,11 +331,12 @@ def signals_slots_handler(
                     f"{cls.__name__} overriding inherited attr: {o.name} as a system property overriding it"
                 )
             elif o.inherited and k in cls_dict:
-                log.debug(
+                log.warning(
                     f"{cls.__name__} overriding inherited attr: {o.name} as {cls_dict[k]} in cls"
                 )
                 # FIXME: should we deepcopy?
-                cls.__anony_store[k] = sscb = lambda: copy.copy(cls_dict[k])
+                val = copy.copy(cls_dict[k])
+                cls.__anony_store[k] = sscb = lambda: val
                 out.append(o.evolve(default=attrs.Factory(sscb)))
             else:
                 log.msg(f"{cls.__name__} adding attr: {o.name}")

engforge/datastores/__init__.py

@@ -4,6 +4,7 @@
 import importlib.util
 from pathlib import Path
 
+
 def get_project_root():
     """Find the project root containing pyproject.toml"""
     current = Path(__file__).parent
@@ -13,71 +14,84 @@ def get_project_root():
         current = current.parent
     return None
 
+
 def install_optional_dependencies(group_name="database"):
     """Install optional dependencies for a specific group"""
     project_root = get_project_root()
     if not project_root:
         print("Could not find pyproject.toml. Manual installation required:")
         print(f"pip install engforge[{group_name}]")
         return False
-    
+
     try:
         # Try to import tomllib (Python 3.11+) or tomli (fallback)
         try:
             import tomllib
         except ImportError:
             import tomli as tomllib
-        
+
         # Read pyproject.toml
         with open(project_root / "pyproject.toml", "rb") as f:
             config = tomllib.load(f)
-        
+
         optional_deps = config.get("project", {}).get("optional-dependencies", {})
         if group_name not in optional_deps:
             print(f"No optional dependency group '{group_name}' found")
             return False
-        
+
         # Install the optional dependencies
         package_name = config.get("project", {}).get("name", "engforge")
         install_spec = f"{package_name}[{group_name}]"
-        
+
         print(f"Installing {install_spec}...")
-        result = subprocess.run([
-            sys.executable, "-m", "pip", "install", install_spec
-        ], capture_output=True, text=True)
-        
+        result = subprocess.run(
+            [sys.executable, "-m", "pip", "install", install_spec],
+            capture_output=True,
+            text=True,
+        )
+
         if result.returncode == 0:
             print(f"✅ Successfully installed {install_spec}")
             return True
         else:
             print(f"❌ Failed to install {install_spec}")
             print(f"Error: {result.stderr}")
             return False
-            
+
     except Exception as e:
         print(f"Error during auto-installation: {e}")
         print(f"Please install manually: pip install engforge[{group_name}]")
         return False
 
+
 def check_and_install_datastores():
     """Check if datastores dependencies are available, auto-install if needed"""
     try:
         import engforge.datastores.data
+
         return True
     except ImportError as e:
         print(f"Datastores dependencies not available: {e}")
         print("")
-        
+
         # Check if we're in development mode (editable install) and interactive
         project_root = get_project_root()
-        is_interactive = hasattr(sys, 'ps1') or sys.stdout.isatty()
-        
-        if project_root and (project_root / "pyproject.toml").exists() and is_interactive:
+        is_interactive = hasattr(sys, "ps1") or sys.stdout.isatty()
+
+        if (
+            project_root
+            and (project_root / "pyproject.toml").exists()
+            and is_interactive
+        ):
             try:
-                answer = input("Auto-install database dependencies? (y/N): ").strip().lower()
-                if answer in ['y', 'yes']:
+                answer = (
+                    input("Auto-install database dependencies? (y/N): ").strip().lower()
+                )
+                if answer in ["y", "yes"]:
                     if install_optional_dependencies("database"):
-                        print("Please restart your Python session to use the newly installed dependencies.")
+                        print(
+                            "Please restart your Python session to use the newly installed dependencies."
+                        )
                         return False
                     else:
                         print("Auto-installation failed. Install manually with:")
@@ -96,6 +110,7 @@ def check_and_install_datastores():
             print("pip install engforge[database]")
             return False
 
+
 # Auto-check and install on import
 if not check_and_install_datastores():
     pass  # Dependencies not available, but user has been informed

engforge/dynamics.py

@@ -8,7 +8,7 @@
 
 #TODO: The top level system will collect the underlying dynamical systems and combine them to an index and overall state space model. This will allow for the creation of a system of systems, and the ability to create a system of systems with a single state space model.
 
-#TODO: integration is done by the solver, where DynamicSystems have individual solver control, solver control is set for a smart default scipy 
+#TODO: integration is done by the solver, where DynamicSystems have individual solver control, solver control is set for a smart default scipy
 """
 
 from engforge.configuration import Configuration, forge
@@ -29,7 +29,6 @@
 from collections import OrderedDict
 import numpy as np
 import pandas
-import expiringdict
 import attr, attrs
 
 

engforge/eng/costs.py

@@ -4,14 +4,14 @@
 
 CostModel's can have cost_property's which detail how and when a cost should be applied & grouped. By default each CostModel has a `cost_per_item` which is reflected in `item_cost` cost_property set on the `initial` term as a `unit` category. Multiple categories of cost are also able to be set on cost_properties as follows
 
-Cost Models can represent multiple instances of a component, and can be set to have a `num_items` multiplier to account for multiple instances of a component. CostModels can have a `term_length` which will apply costs over the term, using the `cost_property.mode` to determine at which terms a cost should be applied. 
+Cost Models can represent multiple instances of a component, and can be set to have a `num_items` multiplier to account for multiple instances of a component. CostModels can have a `term_length` which will apply costs over the term, using the `cost_property.mode` to determine at which terms a cost should be applied.
 
 ```
 @forge
 class Widget(Component,CostModel):
-    
+
     #use num_items as a multiplier for costs, `cost_properties` can have their own custom num_items value.
-    num_items:float = 100 
+    num_items:float = 100
 
     @cost_property(mode='initial',category='capex,manufacturing',num_items=1)
     def cost_of_XYZ(self) -> float:

engforge/eng/geometry.py

@@ -1,4 +1,4 @@
-"""These exist as in interface to sectionproperties from PyNite"""
+"""These exist as in interface to sectionproperties from Pynite"""
 
 from engforge.configuration import Configuration, forge, LoggingMixin
 from engforge.properties import (