Feat/asharp model

.github/workflows/ash-build-and-scan.yml

@@ -185,11 +185,18 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
+          cache: 'poetry'
+
+      - name: Install Poetry
+        run: |
+          pipx install poetry==2.1.2
+          poetry config virtualenvs.create true
+          poetry config virtualenvs.in-project true
 
       - name: Install dependencies
         run: pip install -r requirements.txt

docs/content/docs/development/api/.pages

@@ -0,0 +1,4 @@
+title: API Reference
+nav:
+    - Overview: README.md
+    - ...

docs/content/docs/development/api/base.converter_plugin.md

@@ -0,0 +1,132 @@
+<!-- markdownlint-disable -->
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `base.converter_plugin`
+Module containing the ConverterPlugin base class. 
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L13"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `ConverterPluginConfigBase`
+
+
+
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L20"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `ConverterPluginBase`
+Base converter plugin with some methods of the IConverter abstract class implemented for convenience. 
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L51"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>method</kbd> `configure`
+
+```python
+configure(config: ConverterPluginConfigBase | None = None) → None
+```
+
+Configure the converter with provided configuration. 
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L64"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>method</kbd> `convert`
+
+```python
+convert(target: Path | str) → List[Path]
+```
+
+Execute the converter on the target prior to scans. 
+
+Returns the list of Path objects emitted by the `convert()` operation that correspond to scannable files emitted to the work_dir. 
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L35"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>method</kbd> `setup_paths`
+
+```python
+setup_paths() → Self
+```
+
+Set up default paths and initialize plugin configuration. 
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/converter_plugin.py#L59"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>method</kbd> `validate`
+
+```python
+validate() → bool
+```
+
+Validate converter configuration and requirements. 
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/content/docs/development/api/base.md

@@ -0,0 +1,16 @@
+<!-- markdownlint-disable -->
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/__init__.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `base`
+
+
+
+
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/content/docs/development/api/base.options.md

@@ -0,0 +1,148 @@
+<!-- markdownlint-disable -->
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/options.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `base.options`
+
+
+
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/options.py#L4"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `BuilderOptionsBase`
+Base class for builder options. 
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/options.py#L10"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `ConverterOptionsBase`
+Base class for converter options. 
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/options.py#L16"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `ScannerOptionsBase`
+Base class for scanner options. 
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/options.py#L22"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `ReporterOptionsBase`
+Base class for reporter options. 
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/content/docs/development/api/base.plugin_config.md

@@ -0,0 +1,49 @@
+<!-- markdownlint-disable -->
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/plugin_config.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `base.plugin_config`
+
+
+
+
+
+
+---
+
+<a href="https://github.com/example/my-project/blob/main/src/automated_security_helper/base/plugin_config.py#L10"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `PluginConfigBase`
+Base converter configuration model with common settings. 
+
+
+---
+
+#### <kbd>property</kbd> model_extra
+
+Get extra fields set during validation. 
+
+
+
+**Returns:**
+  A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. 
+
+---
+
+#### <kbd>property</kbd> model_fields_set
+
+Returns the set of fields that have been explicitly set on this model instance. 
+
+
+
+**Returns:**
+  A set of strings representing the fields that have been set,  i.e. that were not filled from defaults. 
+
+
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._