orca-platform-sdk-ui 1.0.8__tar.gz

orca_platform_sdk_ui-1.0.8/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+All notable changes to Orca SDK 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]
+
+### Planned
+
+- Enhanced caching mechanisms
+- Additional storage backends
+- Improved middleware system
+- More deployment adapters (Cloud Run, ECS, etc.)
+
+## [1.0.4] - 2025-12-29
+
+### Added
+
+- **Lambda Adapter**: Complete AWS Lambda deployment support
+  - Automatic HTTP, SQS, and Cron event handling
+  - Event loop management for Python 3.11+
+  - Automatic SQS queuing when `SQS_QUEUE_URL` exists
+  - Production-ready templates and examples
+- **Storage SDK**: Integrated file storage management
+  - `OrcaStorage` client for unified storage operations
+  - Support for bucket management, file operations, and permissions
+- **Design Patterns**: Professional pattern implementations
+  - `OrcaBuilder` and `SessionBuilder` for fluent interfaces
+  - Context managers for resource management
+  - Middleware system with chain of responsibility
+- **Documentation**: Comprehensive guides for Lambda, Storage, and API
+
+### Changed
+
+- **Architecture**: Core refactoring to SOLID principles
+- **Session Management**: Improved composition and cleaner API surface
+- **Error Handling**: Enhanced custom exception hierarchy
+
+### Improved
+
+- **Type Safety**: 100% type hint coverage
+- **Logging**: Professional logging configuration with rotation
+
+## [1.0.0] - 2024-XX-XX
+
+### Added
+
+- Initial release
+- Basic streaming functionality
+- Real-time communication with Centrifugo
+- Button rendering, loading indicators, and usage tracking
+
+---
+
+## Upgrade Guide
+
+### Migrating to 1.0.4
+
+#### Import Changes
+
+```python
+# Old
+from orca.unified_handler import OrcaHandler
+
+# New
+from orca import OrcaHandler
+```
+
+#### Session API Improvements
+
+The API has been moved to a more organized structure:
+
+```python
+# Old
+session.start_loading("thinking")
+session.button_link("Click", "https://example.com")
+
+# New
+session.loading.start("thinking")
+session.button.link("Click", "https://example.com")
+```
+
+#### Backward Compatibility
+
+The old flat session API still works but is deprecated and will be removed in future versions.
+
+---
+
+## Support
+
+For questions or issues:
+
+- Email: [support@orcaolatform.ai](mailto:support@orcaolatform.ai)
+- GitHub: [orcapt/orca-pip](https://github.com/orcapt/orca-pip/issues)

orca_platform_sdk_ui-1.0.8/CONTRIBUTING.md

@@ -0,0 +1,278 @@
+# Contributing to Orca SDK
+
+Thank you for your interest in contributing to Orca SDK! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+By participating in this project, you agree to maintain a respectful and inclusive environment for all contributors.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.8 or higher
+- Git
+- pip
+
+### Setting Up Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/orcapt/orca-pip
+cd orca-pip
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Install development dependencies
+pip install pytest pytest-cov black mypy flake8
+```
+
+## Development Workflow
+
+### 1. Create a Branch
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+Use prefixes:
+
+- `feature/` for new features
+- `fix/` for bug fixes
+- `docs/` for documentation
+- `refactor/` for code refactoring
+- `test/` for test improvements
+
+### 2. Make Changes
+
+- Write clean, readable code
+- Follow PEP 8 style guide
+- Add docstrings to functions and classes
+- Update tests for your changes
+- Update documentation if needed
+
+### 3. Run Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=orca --cov-report=html
+
+# Run specific test file
+pytest tests/test_handler.py
+
+# Run with verbose output
+pytest -v
+```
+
+### 4. Code Quality Checks
+
+```bash
+# Format code with black
+black orca/ tests/ examples/
+
+# Type checking with mypy
+mypy orca/
+
+# Linting with flake8
+flake8 orca/ tests/ examples/
+```
+
+### 5. Commit Your Changes
+
+```bash
+git add .
+git commit -m "feat: add new feature"
+```
+
+Use conventional commit messages:
+
+- `feat:` for new features
+- `fix:` for bug fixes
+- `docs:` for documentation
+- `refactor:` for code refactoring
+- `test:` for tests
+- `chore:` for maintenance
+
+### 6. Push and Create Pull Request
+
+```bash
+git push origin feature/your-feature-name
+```
+
+Then create a pull request on GitHub.
+
+## Code Guidelines
+
+### Python Style
+
+- Follow PEP 8
+- Use type hints
+- Maximum line length: 100 characters
+- Use meaningful variable names
+- Add docstrings to all public functions/classes
+
+Example:
+
+```python
+from typing import Optional, Dict, Any
+
+def process_data(
+    data: Dict[str, Any],
+    options: Optional[Dict[str, Any]] = None
+) -> str:
+    """
+    Process data with optional configuration.
+
+    Args:
+        data: Input data dictionary
+        options: Optional configuration parameters
+
+    Returns:
+        Processed result as string
+
+    Raises:
+        ValueError: If data is invalid
+    """
+    if not data:
+        raise ValueError("Data cannot be empty")
+
+    # Processing logic
+    return str(data)
+```
+
+### Architecture
+
+Orca SDK follows clean architecture principles:
+
+1. **Domain Layer** (`domain/`)
+
+   - Interfaces and models
+   - No dependencies on other layers
+
+2. **Services Layer** (`services/`)
+
+   - Business logic
+   - Depends only on domain
+
+3. **Infrastructure Layer** (`infrastructure/`)
+
+   - External clients (API, Centrifugo, etc.)
+   - Implements domain interfaces
+
+4. **Core Layer** (`core/`)
+   - Main handler and session orchestration
+   - Uses services and infrastructure
+
+When adding new features:
+
+- Define interfaces in `domain/`
+- Implement business logic in `services/`
+- Add external integrations in `infrastructure/`
+- Wire everything in `core/`
+
+### Testing
+
+- Write unit tests for all new code
+- Aim for >80% code coverage
+- Use mocking for external dependencies
+- Test edge cases and error conditions
+
+Example test:
+
+```python
+import pytest
+from orca import OrcaHandler
+
+def test_handler_initialization():
+    """Test that handler initializes correctly."""
+    handler = OrcaHandler(dev_mode=True)
+    assert handler.dev_mode is True
+
+def test_handler_begin_session():
+    """Test session creation."""
+    handler = OrcaHandler(dev_mode=True)
+    # Test logic here
+    pass
+
+def test_error_handling():
+    """Test error handling."""
+    handler = OrcaHandler(dev_mode=True)
+    with pytest.raises(ValueError):
+        # Code that should raise error
+        pass
+```
+
+### Documentation
+
+- Update README.md for user-facing changes
+- Add docstrings to all public APIs
+- Update guides in `docs/` for major features
+- Add examples to `examples/` directory
+
+## Pull Request Process
+
+1. **Ensure Tests Pass**: All tests must pass
+2. **Update Documentation**: Update relevant docs
+3. **Add Examples**: Add examples if adding new features
+4. **Code Review**: Wait for maintainer review
+5. **Address Feedback**: Make requested changes
+6. **Squash Commits**: Keep PR history clean
+
+## Pull Request Template
+
+```markdown
+## Description
+
+Brief description of changes
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+
+## Testing
+
+- [ ] Unit tests added/updated
+- [ ] Integration tests added/updated
+- [ ] All tests pass
+
+## Checklist
+
+- [ ] Code follows style guidelines
+- [ ] Self-review completed
+- [ ] Documentation updated
+- [ ] No new warnings
+- [ ] Tests added
+```
+
+## Release Process
+
+Releases are handled by maintainers:
+
+1. Update version in `setup.py`
+2. Update `CHANGELOG.md`
+3. Create git tag
+4. Build and publish to PyPI
+5. Create GitHub release
+
+## Questions?
+
+- Open an issue for bugs or feature requests
+- Join our Discord for discussions
+- Email support@orcaolatform.ai for other questions
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+Thank you for contributing to Orca SDK! 🚀

orca_platform_sdk_ui-1.0.8/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Orca Platform Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

orca_platform_sdk_ui-1.0.8/MANIFEST.in

@@ -0,0 +1,26 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include CONTRIBUTING.md
+include SECURITY.md
+include orca/requirements.txt
+include orca/*.md
+include orca/*.txt
+recursive-include orca *.py
+recursive-include orca *
+# Include documentation files
+recursive-include docs *.md
+recursive-include examples *.md
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store
+recursive-exclude * .git*
+recursive-exclude * .vscode*
+recursive-exclude * .idea*
+recursive-exclude * orca_env*
+recursive-exclude * .pytest_cache*
+recursive-exclude * *.egg-info*
+recursive-exclude * dist*
+recursive-exclude build *
+recursive-exclude * build/
+