Merge enhancement into master

Author: unsektor

.github/workflows/ci.yaml

@@ -0,0 +1,122 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    tags: '*.*.*'
+  release:
+    types: [ published ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
+          - '3.13'
+          - '3.14'
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e . --extra-index-url https://source.md.land/python/
+        python -m pip install pytest pytest-cov
+        # pip install -e ".[test]"
+
+    - name: Run tests
+      run: |
+        # python -m pytest tests/ --cov=lib --cov-report=xml
+        export PYTHONPATH="$(pwd -P)/lib:$PYTHONPATH"
+        python -m pytest tests/unit/md/processor/processor.py --cov=lib --cov-report=term
+
+    # - name: Upload coverage to Codecov
+    #   uses: codecov/codecov-action@v3
+    #   if: matrix.python-version == '3.10'
+    #   with:
+    #     file: ./coverage.xml
+    #     fail_ci_if_error: true
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install safety
+      run: pip install safety
+
+    - name: Check dependencies for vulnerabilities
+      run: safety check --full-report
+
+    - name: Install bandit
+      run: pip install bandit
+
+    - name: Static security analysis
+      run: bandit -r lib/ -f json -o bandit-report.json --skip B101
+
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install mypy
+      run: pip install mypy
+
+    - name: Install dependencies
+      run: pip install -e . --extra-index-url https://source.md.land/python/
+
+    - name: Type checking
+      run: |
+        export PYTHONPATH="$(pwd -P)/lib:$PYTHONPATH"
+        mypy lib/ --disable-error-code import-untyped
+
+  build:
+    needs: [test, security, type-check]
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install build dependencies
+      run: pip install build wheel
+
+    - name: Build wheel package
+      run: python -m build --wheel
+
+    - name: List artifacts
+      run: ls -la dist/
+
+    - name: Upload wheel to GitHub Releases
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: dist/*.whl
+        tag: ${{ github.ref }}
+        overwrite: true
+        file_glob: true

changelog.md

@@ -9,9 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - add retry logic
 
+## [1.1.0] — 2026-01-02 
+### Added
+
+- [x] feature: add generic typing for contracts and base implementation 
+- [x] feature: add CI/CD github workflow configuration 
 
 ## [1.0.0] - 2022-05-19
 
 - Implementation initialization
 
+[1.1.0]: https://github.com/md-py/md.processor/compare/1.0.0..1.1.0
 [1.0.0]: https://github.com/md-py/md.processor/releases/tag/1.0.0

docs/index.md

@@ -105,17 +105,25 @@ if __name__ == '__main__':
 ```
 
 ```python3
-if __name__ == '__main__':            
+if __name__ == '__main__':
     # Use case #3: as same as #2 using `worker` concept 
     worker = md.processor.Worker(
         provider=convert_image_task_provider,
         processor=convert_image_processor,
     )
-    
+
     try:
         worker.run()
     except ConvertException as e:
         exit(1)
 ```
 
+## Thread safe provider
+
+Python does not provide thread safe access to generators by default, 
+in case when task provider is assumed to be shared and used in few threads,
+consider to wrap provider with thread safe provider from 
+[md.processor.threading](../md.processor.threading/) component to prevent 
+race-condition issue.
+
 [architecture-overview]: _static/architecture.class-diagram.svg

lib/md/processor/_processor.py

@@ -3,7 +3,7 @@
 
 # Metadata
 __author__ = 'https://md.land/md'
-__version__ = '1.0.0'
+__version__ = '1.1.0'
 __all__ = (
     # Metadata
     '__author__',
@@ -21,6 +21,8 @@
 )
 
 
+T = typing.TypeVar('T', bound='TaskInterface')
+
 # Exception
 class ProcessorException(RuntimeError):
     """ Component marker exception """
@@ -43,21 +45,21 @@ class TaskInterface:
     pass
 
 
-class ProviderInterface:
+class ProviderInterface(typing.Generic[T]):
     """ Provides task to process """
-    def provide(self) -> typing.Iterator[TaskInterface]:
+    def provide(self) -> typing.Iterator[T]:
         raise NotImplementedError
 
 
-class ProcessorInterface:
+class ProcessorInterface(typing.Generic[T]):
     """ Processes task """
-    def process(self, task: TaskInterface) -> None:
+    def process(self, task: T) -> None:
         raise NotImplementedError
 
 
 # Implementation
-class Worker:  # nt: unit
-    def __init__(self, provider: ProviderInterface, processor: ProcessorInterface) -> None:
+class Worker(typing.Generic[T]):  # nt: unit
+    def __init__(self, provider: ProviderInterface[T], processor: ProcessorInterface[T]) -> None:
         self._provider = provider
         self._processor = processor
 

setup.py

@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name='md.processor',
-    version='1.0.0',
+    version='1.1.0',
     description='Common task processing contracts',
     long_description=long_description,
     long_description_content_type='text/markdown',