README.md

Documentation

Welcome to the comprehensive documentation for nui-python-shared-utils (formerly nui-lambda-shared-utils).

Last Updated: 2026-02-13

Quick Navigation

📚 Getting Started

• Installation Guide - Setup and dependency management
• Configuration Guide - Environment setup and credential management
• Quick Start - Common usage patterns and examples

📖 Guides

Component-specific guides for major features:

• AWS Powertools Integration - Standardized logging, metrics, and error handling
• Lambda Context Helpers - Environment info extraction for logging and metrics
• Slack Integration - Messaging, formatting, and file uploads
• Elasticsearch Integration - Search, bulk indexing, health checks
• Snowflake Integration - SQL API client, Secrets Manager credentials, sync/async usage
• JWT Authentication - RS256 token validation for API Gateway Lambdas
• Anthropic (Claude) Integration - Client helper for API-key/Bedrock auth, forced tool-use, and text calls
• Log Processing - Kinesis log extraction and ES index naming
• Database Connections (planned)
• Error Handling Patterns (planned)
• CloudWatch Metrics (planned)

🔧 CLI Tools

Command-line utilities included with the package:

• Slack Channel Setup - Automate Slack workspace channel creation
• Additional CLI tools (planned)

📋 Reference

API reference and detailed component documentation:

• Shared Types & Data Structures - Core types, interfaces, and response structures
• Client APIs (planned)
• Utility Functions (planned)
• Configuration Options (planned)

🛠️ Development

Developer resources and contribution guidelines:

• Testing Guide - Test strategies and running tests
• Contributing - Development workflow
• Changelog - Version history

📦 Templates

• Slack Account Names - AWS account name mappings for Slack
• Channel Configuration - Channel setup for slack-channel-setup CLI

📁 Archive

Historical documentation and analysis:

• Test Coverage Analysis (outdated - see actual coverage in CI)
• Lambda Shared Utils Analysis (migration doc)

Documentation Structure

docs/
├── README.md                    # This file - main documentation homepage
├── getting-started/             # User onboarding
│   ├── installation.md
│   ├── configuration.md
│   └── quickstart.md
├── guides/                      # Component-specific how-to guides
├── reference/                   # API reference documentation
├── development/                 # Developer resources
│   └── testing.md
├── templates/                   # Configuration templates
│   └── slack_config.yaml.template
└── archive/                     # Outdated/historical docs
    ├── TEST_COVERAGE_ANALYSIS.md
    └── LAMBDA_SHARED_UTILS_ANALYSIS.md

User Journeys

New Users

1. Start with this README for overview
2. Follow Installation Guide
3. Review Configuration Guide
4. Try examples in Quick Start

Integration Focus

• Jump to specific component guides (when available)
• Reference Configuration Guide for setup
• Use Quick Start for code examples

Development Contributors

1. Read Contributing Guidelines
2. Review Testing Guide
3. Check Changelog for recent changes

Contributing to Documentation

When contributing to documentation:

1. Follow the structure - Place new docs in appropriate directories
2. Include code examples - Provide working, tested code snippets
3. Cross-reference - Link related topics for easy navigation
4. Add to this README - Update navigation when adding new docs
5. Test examples - Ensure all code works with current version
6. Add last-updated dates - Help users know doc freshness

Documentation Status

✅ Available

• Main documentation (this README)
• Getting started guides (installation, configuration, quickstart)
• AWS Powertools integration guide (guides/powertools-integration.md)
• Lambda context helpers guide (guides/lambda-utilities.md)
• Slack integration guide (guides/slack-integration.md)
• Elasticsearch integration guide (guides/elasticsearch-integration.md)
• Snowflake integration guide (guides/snowflake-integration.md)
• JWT authentication guide (guides/jwt-authentication.md)
• Anthropic (Claude) integration guide (guides/llm-integration.md)
• Shared types reference (guides/shared-types.md)
• CLI tools guide (guides/cli-tools.md)
• Testing guide (development/testing.md)
• Configuration templates (Slack account names, channel setup)

🚧 Planned

• Component-specific guides (Database, Metrics, Error Handling)
• API reference documentation
• Advanced topics (AWS infrastructure, Lambda integration)
• Troubleshooting guide

Local Viewing

Markdown Viewers

Most IDEs and editors can preview markdown files natively.

Static Site Generation (Optional)

Using MkDocs:

pip install mkdocs mkdocs-material
mkdocs serve

Using Sphinx:

pip install sphinx sphinx-rtd-theme
sphinx-quickstart docs
make html

Online Documentation

• GitHub Repository: https://github.com/nuimarkets/nui-python-shared-utils
• Package Page: https://pypi.org/project/nui-python-shared-utils/

---

Documentation last updated 2025-11-19 with AWS Powertools integration guide.