nui-python-shared-utils 1.3.0__tar.gz

nui_python_shared_utils-1.3.0/.editorconfig

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 120
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+max_line_length = off
+
+[Makefile]
+indent_style = tab

nui_python_shared_utils-1.3.0/.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Cache pip dependencies
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml', '**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        echo "Installing test requirements..."
+        pip install -r requirements-test.txt
+        echo "Installing package..."
+        pip install -e .
+        echo "Verifying key dependencies:"
+        python -c "import elasticsearch; print('✓ elasticsearch')" || echo "✗ elasticsearch missing"
+        python -c "import slack_sdk; print('✓ slack_sdk')" || echo "✗ slack_sdk missing" 
+        python -c "import pymysql; print('✓ pymysql')" || echo "✗ pymysql missing"
+    
+    - name: Auto-format with black
+      run: |
+        black nui_lambda_shared_utils tests
+        if ! git diff --quiet; then
+          echo "::warning::Code was auto-formatted by Black"
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add -A
+          git commit -m "Auto-format code with Black [skip ci]" || echo "No changes to commit"
+        else
+          echo "✅ Code is already properly formatted"
+        fi
+    
+    - name: Type check with mypy
+      run: |
+        mypy nui_lambda_shared_utils --ignore-missing-imports
+      continue-on-error: true  # Don't fail CI on type errors yet
+    
+    - name: Test with pytest
+      run: |
+        pytest --cov=nui_lambda_shared_utils --cov-report=xml --cov-report=term-missing -v
+    
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  build:
+    name: Build Package
+    runs-on: ubuntu-latest
+    needs: test
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check package integrity
+      run: |
+        twine check dist/*
+        echo "Package contents:"
+        python -m tarfile -l dist/*.tar.gz | head -20
+        echo "Wheel contents:"
+        python -m zipfile -l dist/*.whl | head -20
+    
+    - name: Test installation
+      run: |
+        pip install dist/*.whl
+        python -c "import nui_lambda_shared_utils; print('✅ Package imports successfully')"
+        python -c "from nui_lambda_shared_utils import Config, get_secret; print('✅ Core imports work')"

nui_python_shared_utils-1.3.0/.github/workflows/publish.yml

@@ -0,0 +1,136 @@
+name: Build and Publish to PyPI
+
+on:
+  push:
+    tags:
+      - '[0-9]*'  # Trigger on version tags like 1.3.0
+  release:
+    types: [published]
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - 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
+        echo "Installing test requirements..."
+        pip install -r requirements-test.txt
+        echo "Installing package..."
+        pip install -e .
+        echo "Verifying key dependencies:"
+        python -c "import elasticsearch; print('✓ elasticsearch')" || echo "✗ elasticsearch missing"
+        python -c "import slack_sdk; print('✓ slack_sdk')" || echo "✗ slack_sdk missing" 
+        python -c "import pymysql; print('✓ pymysql')" || echo "✗ pymysql missing"
+    
+    - name: Run tests
+      run: |
+        pytest --cov=nui_lambda_shared_utils --cov-report=xml --cov-report=term-missing
+    
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: false
+
+  build:
+    name: Build Distribution
+    runs-on: ubuntu-latest
+    needs: test
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Full history for version calculation
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check package
+      run: |
+        twine check dist/*
+        python -m tarfile -l dist/*.tar.gz
+    
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [test, build]
+    # Only publish on tagged releases
+    if: github.event_name == 'release' || startsWith(github.ref, 'refs/tags/')
+    environment:
+      name: pypi
+      url: https://pypi.org/project/nui-python-shared-utils/
+    
+    permissions:
+      id-token: write  # For trusted publishing
+      contents: read
+    
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: true
+        print-hash: true
+
+  publish-test:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-latest
+    needs: [test, build]
+    # Publish to TestPyPI on manual trigger or development branches
+    if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && !startsWith(github.ref, 'refs/tags/'))
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/nui-python-shared-utils/
+    
+    permissions:
+      id-token: write
+      contents: read
+    
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    
+    - name: Publish to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        verbose: true
+        print-hash: true

nui_python_shared_utils-1.3.0/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11']
+
+    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
+        pip install -r requirements-test.txt
+        pip install -e .
+    
+    - name: Check formatting with black
+      run: |
+        black --check --diff nui_lambda_shared_utils tests || {
+          echo "::warning::Code formatting issues found - run 'black nui_lambda_shared_utils tests' locally"
+          echo "Continuing build despite formatting issues..."
+        }
+    
+    # TODO: Re-enable mypy after fixing type annotations
+    # - name: Type check with mypy
+    #   run: |
+    #     mypy lambda_shared_utils/ --config-file mypy.ini
+    
+    - name: Test with pytest
+      run: |
+        pytest --cov=nui_lambda_shared_utils --cov-report=xml

nui_python_shared_utils-1.3.0/.markdownlint-cli2.yaml

@@ -0,0 +1,47 @@
+# Markdownlint configuration for nui-python-shared-utils
+# Extends workspace config with project-specific overrides
+
+config:
+  # Enable all rules by default
+  default: true
+
+  # MD013: Line length - disabled (technical docs need long lines for URLs/commands)
+  MD013: false
+
+  # MD033: Inline HTML - allowed (needed for complex formatting)
+  MD033: false
+
+  # MD036: No emphasis as heading - disabled (acceptable in planning docs)
+  MD036: false
+
+  # MD040: Fenced code language - disabled (not all code blocks need language tags)
+  MD040: false
+
+  # MD041: First line heading - disabled (docs may start with metadata)
+  MD041: false
+
+  # MD024: Multiple headings with same content - allowed with different levels
+  MD024:
+    siblings_only: true
+
+  # MD034: Bare URLs - allowed (sometimes intentional)
+  MD034: false
+
+  # MD046: Code block style - prefer fenced
+  MD046:
+    style: "fenced"
+
+  # MD060: Table column style - disabled (minor formatting preference)
+  MD060: false
+
+# File patterns to check
+globs:
+  - "**/*.md"
+
+# Exclusions
+ignores:
+  - "node_modules/**"
+  - "vendor/**"
+  - ".git/**"
+  - "venv/**"
+  - ".venv/**"

nui_python_shared_utils-1.3.0/CHANGELOG.md

@@ -0,0 +1,122 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- **Log Processors Module** - New `log_processors` module for Kinesis/CloudWatch log extraction:
+  - `extract_cloudwatch_logs_from_kinesis()` - Base64 decode, gzip decompress, CONTROL_MESSAGE filtering with callback-based processing
+  - `derive_index_name()` - Configurable ES index name derivation from log group and timestamp
+  - `CloudWatchLogEvent`, `CloudWatchLogsData` type definitions for IDE support
+  - No new dependencies (stdlib only)
+  - Consolidates ~60 lines of duplicated extraction code across Lambda projects
+
+- **AWS Powertools Integration** - New `powertools_helpers` module for standardized Lambda function patterns:
+  - `get_powertools_logger()` - Logger with Elasticsearch-compatible timestamps (`2025-01-18T04:39:27.788Z`)
+  - `powertools_handler()` - Decorator combining logging, metrics, and error handling with Slack alerts
+  - Automatic Lambda vs local environment detection
+  - Local development with coloredlogs support
+  - CloudWatch metrics integration
+  - Graceful degradation for optional dependencies
+  - Complete test coverage (94.52%) with 20 comprehensive tests
+- **New optional dependency group**: `[powertools]` for AWS Lambda Powertools integration
+  - `aws-lambda-powertools>=3.6.0,<4.0.0`
+  - `coloredlogs>=15.0`
+- **Comprehensive Powertools documentation**:
+  - New guide: `docs/guides/powertools-integration.md` (500+ lines)
+  - Updated quick start examples in README and quickstart guide
+  - Migration guide from custom logger wrappers
+  - Troubleshooting section for common issues
+- `service_name` parameter to `SlackClient` for custom display names (e.g., "my-service" instead of full Lambda name)
+- Project root improvements (documentation cleanup, standard files)
+- Enhanced .gitignore with project-specific entries
+- New `slack-channel-setup` CLI tool for Slack workspace automation
+
+### Changed
+
+- Improved Slack Lambda header formatting:
+  - Removed 📍 (round_pushpin) emoji for cleaner display
+  - Consolidated header to 2 lines (service name + account/region/log info)
+  - Updated local testing header to match new format
+- Rebranded package as production-ready and generic for any AWS Lambda environment
+- Updated documentation to emphasize configurability and generic usage patterns
+
+### Breaking Changes
+
+- **Removed `SERVICE_EMOJI` from public API exports**: The Slack alert formatter (`SlackFormatter.add_alert()`) no longer displays service-specific emojis next to service names. Service names now display in uppercase without emojis (e.g., "SERVICE" instead of "service 🚀").
+  - **Migration**: If you need service emojis, create your own emoji mapping and format the service name before passing it to `SlackFormatter.add_alert()`:
+
+    ```python
+    SERVICE_EMOJI = {"orders": "📦", "auth": "🔐", "notifications": "📧"}
+    emoji = SERVICE_EMOJI.get(service_name, "")
+    formatted_service = f"{service_name} {emoji}" if emoji else service_name
+    formatter.add_alert(service=formatted_service, ...)
+    ```
+
+- **Removed database helper methods**: `get_entity_stats()` and `get_record_stats()` have been removed from `DatabaseClient`. Use the generic `query()` method instead with your own SQL.
+- **`format_currency()` now requires currency parameter**: Previously accepted optional currency with "NZD" default. Now requires explicit currency code to avoid assumptions about user's locale.
+
+## [0.0.6] - 2025-11-16
+
+### Added
+
+- Configuration YAML support for account info
+- RabbitMQ integration utilities
+
+### Changed
+
+- Enhanced configuration system
+
+## [0.0.5] - 2025-09-29
+
+### Added
+
+- Comprehensive test improvements
+- Better test coverage across modules
+
+### Fixed
+
+- Various test fixes and improvements
+
+## [0.0.4] - 2025-09-05
+
+### Changed
+
+- Minor improvements and fixes
+
+## [0.0.3] - 2025-09-05
+
+### Changed
+
+- Initial improvements
+
+## [0.0.2] - 2025-09-05
+
+### Added
+
+- Initial package structure
+- Core client implementations (Slack, Elasticsearch, Database)
+- Metrics publishing utilities
+- Error handling decorators
+- Timezone utilities for NZ timezone handling
+
+## [0.0.1] - 2025-09-05
+
+### Added
+
+- Initial release
+- Basic project structure
+- Python package configuration
+
+[Unreleased]: https://github.com/nuimarkets/nui-python-shared-utils/compare/0.0.6...HEAD
+[0.0.6]: https://github.com/nuimarkets/nui-python-shared-utils/compare/0.0.5...0.0.6
+[0.0.5]: https://github.com/nuimarkets/nui-python-shared-utils/compare/0.0.4...0.0.5
+[0.0.4]: https://github.com/nuimarkets/nui-python-shared-utils/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/nuimarkets/nui-python-shared-utils/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/nuimarkets/nui-python-shared-utils/compare/0.0.1...0.0.2
+[0.0.1]: https://github.com/nuimarkets/nui-python-shared-utils/releases/tag/0.0.1