Refactor .gitignore for better organization and clarity; update CLI plugin initialization to handle prompts more effectively; enhance ModelObserver error handling; add Plugin API documentation and example usage; include image asset for plugin template.

Author: MatInGit

.github/workflows/docker-build.yml

@@ -28,7 +28,7 @@ jobs:
           echo "VERSION=${TAG_NAME}" >> $GITHUB_ENV
           echo "version=${TAG_NAME}" >> $GITHUB_OUTPUT
 
-      - name: Determine if version is pure semver (e.g. v0.1.2)
+      - name: Determine if version is pure semver
         id: semver_check
         run: |
           if echo "${{ steps.vars.outputs.version }}" | grep -Eq '^v[0-9]+\.[0-9]+\.[0-9]+$'; then

.gitignore

@@ -1,52 +1,157 @@
-main_local.py
-env
-cred.json
+# Python
 __pycache__/
-*lcls-cu-inj-nn/*
-*lcls_cu_inj_nn/*
-kube
-old
-.pytest_cache
-*.egg-info
-mlruns
-generic_model
-torch_model
-model1.txt
-metric2.png
-local_test
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+*.prof
+*.profile
+
+# Virtual Environments
+env/
+.env
+.venv*/
+test-env/
+.venv-*/
+
+# IDE & Editors
+.vscode/
+*.code-workspace
+
+# Testing & Coverage
+.pytest_cache/
 .coverage
-image.png
-output.log
-slack.py
-test.ipynb
-image_model
-test.h5
-.vscode
-/build
+test_files/
+
+# Build Tools
+.ruff_cache/
+build-info*
+
+# MLFlow & Models
+mlruns/
+*lcls-cu-inj-nn/
+*lcls_cu_inj_nn/
+generic_model/
+torch_model/
+image_model/
+astra_*/
+*-surrograte/
+
+# Kubernetes & Deployment
+kube/
+configs/
+*-deployment/
+*-deployment-*/
+cookiecutter-*/
+lebt_*/
+waterfall*/
+
+# Credentials & Secrets
 env.json
+cred.json
 creds.json
+
+# Documentation
+graphs/
+
+# Temporary & Local Files
+tmp*
+old/
+old_examples/
+local_test/
+*.log
+*.png
+*.txt
+*.h5
+test.ipynb
 test.py
-cookiecutter-*
-.ruff_cache
+test.yaml
+image.png
+main_local.py
+slack.py
+_version.py
+notify.profile
+</attachment>
+
+This organizes the `.gitignore` into logical sections with comments, removes redundancy (like combining `env` and `.env`), and groups similar patterns together for easier maintenance.# filepath: /home/gbm96348/nfs_home/lume-deployment/.gitignore
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+*.prof
+*.profile
+
+# Virtual Environments
+env/
+.env
+.venv*/
+test-env/
+.venv-*/
+
+# IDE & Editors
+.vscode/
+*.code-workspace
+
+# Testing & Coverage
+.pytest_cache/
+.coverage
+test_files/
+
+# Build Tools
+.ruff_cache/
 build-info*
-*-deployment-*/
-*-deployment/
-cookiecutter-*/
+
+# MLFlow & Models
+mlruns/
+*lcls-cu-inj-nn/
+*lcls_cu_inj_nn/
+generic_model/
+torch_model/
+image_model/
 astra_*/
+*-surrograte/
+
+# Kubernetes & Deployment
+kube/
 configs/
+*-deployment/
+*-deployment-*/
+cookiecutter-*/
 lebt_*/
-*-surrograte/
 waterfall*/
-_version.py
-dist/
+
+# Credentials & Secrets
+env.json
+cred.json
+creds.json
+
+# Documentation
 graphs/
-.coverage
-.vscode
+
+# Temporary & Local Files
 tmp*
-notify.profile
-test.yaml
-test_files/
+old/
 old_examples/
-*code-workspace
-test-env
-.venv*
+local_test/
+*.log
+*.png
+*.txt
+*.h5
+test.ipynb
+test.py
+test.yaml
+image.png
+main_local.py
+slack.py
+_version.py
+notify.profile
+!image.png

poly_lithic/src/cli.py

@@ -202,7 +202,7 @@ def run_model(config, model_getter, debug, env, one_shot, publish, requirements)
         if requirements:
             click.echo('Requirements-only mode - exiting after installation')
             sys.exit(0)
-        
+        # ugly but we needed to do some legacy support, this will eventially all be click handled
         import argparse
         args = argparse.Namespace(
             config=config,
@@ -242,21 +242,19 @@ def plugin():
 
 
 @plugin.command()
-@click.option('--name', '-n', prompt='Plugin name', 
+@click.option('--name', '-n', default=None,
               help='Name of the plugin package')
-@click.option('--author', '-a', prompt='Author name', default='',
+@click.option('--author', '-a', default=None,
               help='Author name')
-@click.option('--email', prompt='Author email', default='example@email.com',
+@click.option('--email', default=None,
               help='Author email')
-@click.option('--description', '-d', prompt='Short description', default='',
+@click.option('--description', '-d', default=None,
               help='Plugin description')
 @click.option('--output-dir', '--dir', '-o', type=click.Path(), default='.',
               help='Output directory for the plugin project (default: current directory)')
-@click.option('--license', default='MIT',
-              help='License type')
 @click.option('--no-prompt', is_flag=True,
               help='Skip interactive prompts (use defaults or provided values)')
-def init(name, author, email, description, output_dir, license, no_prompt):
+def init(name, author, email, description, output_dir, no_prompt):
     """
     Initialize a new plugin project from template.
     
@@ -274,6 +272,18 @@ def init(name, author, email, description, output_dir, license, no_prompt):
 
         click.echo(click.style('\n🚀 Creating Plugin Project\n', fg='cyan', bold=True))
 
+        # Handle prompts manually based on no_prompt flag
+        if no_prompt:
+            name = name or 'my_plugin'
+            author = author or 'Author Name'
+            email = email or 'example@email.com'
+            description = description or 'A poly_lithic plugin package'
+        else:
+            name = name or click.prompt('Plugin name')
+            author = author or click.prompt('Author name', default='')
+            email = email or click.prompt('Author email', default='example@email.com')
+            description = description or click.prompt('Short description', default='')
+        
         output_path = Path(output_dir).expanduser().resolve()
         plugin_dir_name = PluginGenerator._normalize_package_name(name)
 
@@ -285,13 +295,13 @@ def init(name, author, email, description, output_dir, license, no_prompt):
                 sys.exit(1)
 
         generator = PluginGenerator()
+        
         project_path = generator.generate(
             name=name,
             author=author,
             email=email,
             description=description,
             output_dir=str(output_path),
-            license=license,
         )
 
         click.echo(click.style(f"✓ Plugin project created: {project_path.name}", fg='green', bold=True))

poly_lithic/src/utils/messaging.py

@@ -435,7 +435,17 @@ def __get_model(self):
             return model
 
         else:
-            raise ValueError(f'model type not recognised: {self.config["type"]}')
+            # try the plugin then fail
+            try: 
+                model_getter = registered_model_getters[self.config['type']](
+                    self.config['args']
+                )
+                model = model_getter.get_model()
+                return model
+            except KeyError:
+                raise ValueError(f'model type not recognised: {self.config["type"]}')
+            
+            # raise ValueError(f'model type not recognised: {self.config["type"]}')
 
     def update(self, message: Message) -> list[Message]:
         messages = []

poly_lithic/src/utils/plugin_generator.py

@@ -30,7 +30,6 @@ def generate(
         email: str = '',
         description: str = '',
         output_dir: str = '.',
-        license: str = 'MIT',
     ) -> Path:
         """
         Generate a plugin project from templates.