sector8-sdk 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,172 @@
1
+ # Changelog
2
+
3
+ All notable changes to Sector8-sdk will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [1.0.0] - 2024-07-18
9
+
10
+ ### Added
11
+ - **Sector8 Security Engine** - Unremovable security foundation with advanced threat detection
12
+ - **Sector8 Observability Engine** - Security-enhanced telemetry with threat correlation
13
+ - **Sector8 Intelligence Engine** - Predictive analytics and AI model monitoring
14
+ - **Unified Tracking System** - Integrated security, observability, and intelligence tracking
15
+ - **Automatic Security Scanning** - PII detection, prompt injection detection, content filtering
16
+ - **Compliance Automation** - GDPR, HIPAA, SOC2, ISO27001 compliance validation
17
+ - **Model Governance** - AI model registration, monitoring, drift detection, bias analysis
18
+ - **Predictive Security** - AI-powered threat detection and risk assessment
19
+ - **Intelligent Alerting** - Security-aware alerting with threat correlation
20
+ - **Secure Prompt Management** - Prompt retrieval with automatic security validation
21
+ - **Secure Secrets Management** - Secrets handling with access validation
22
+ - **OpenTelemetry Integration** - Native OpenTelemetry support with security context
23
+ - **Provider Support** - OpenAI, Anthropic, Cohere, Google AI, Azure OpenAI, AWS Bedrock
24
+ - **Enterprise Features** - Multi-tenant support, audit logging, compliance reporting
25
+ - **CLI Interface** - Command-line interface for platform management
26
+ - **Comprehensive Documentation** - Security-first guides and enterprise deployment patterns
27
+
28
+ ### Security Features
29
+ - **Security cannot be fully disabled** - Attempts to disable security result in warnings and minimal enforcement
30
+ - **All operations pass through security checks** - Every LLM call, API request, and data operation
31
+ - **Automatic PII detection and redaction** - Always enabled and cannot be bypassed
32
+ - **Prompt injection detection** - Advanced detection of injection attempts
33
+ - **Content filtering** - Toxicity detection, hate speech detection, content policy enforcement
34
+ - **Bias detection** - AI bias detection and fairness monitoring
35
+ - **Data leakage prevention** - Automatic detection of sensitive data exposure
36
+ - **Zero-trust architecture** - Continuous verification and monitoring
37
+ - **Immutable audit logging** - All security events are logged and cannot be modified
38
+
39
+ ### Observability Features
40
+ - **Security-enhanced telemetry** - All telemetry includes security context
41
+ - **Threat correlation** - Automatic correlation of security events with performance metrics
42
+ - **Compliance tracing** - Automatic tracing of compliance-related operations
43
+ - **Real-time dashboards** - Security-aware dashboards with threat indicators
44
+ - **Performance monitoring** - Performance metrics with security overhead tracking
45
+ - **Distributed tracing** - End-to-end tracing with security context
46
+ - **Event logging** - Comprehensive event logging with security metadata
47
+
48
+ ### Intelligence Features
49
+ - **Model monitoring** - Comprehensive AI model performance monitoring
50
+ - **Drift detection** - Data drift detection with security analysis
51
+ - **Bias analysis** - AI bias detection and fairness metrics
52
+ - **Predictive analytics** - AI-powered threat prediction and risk assessment
53
+ - **Model governance** - Model registry, versioning, and validation
54
+ - **Explainable AI** - Model explainability and interpretability
55
+ - **Cost optimization** - AI cost tracking and optimization recommendations
56
+
57
+ ### Compliance Features
58
+ - **GDPR compliance** - Automatic GDPR compliance validation and reporting
59
+ - **HIPAA compliance** - Healthcare data protection and compliance
60
+ - **SOC2 compliance** - Security, availability, and processing integrity
61
+ - **ISO27001 compliance** - Information security management
62
+ - **PCI DSS compliance** - Payment card industry data security
63
+ - **AI Act compliance** - European AI regulation compliance
64
+ - **Automated reporting** - Compliance report generation and export
65
+
66
+ ### Breaking Changes
67
+ - **Security enforcement is mandatory** - Security cannot be fully disabled
68
+ - **All operations require security scanning** - No bypass mechanisms available
69
+ - **Compliance validation is automatic** - Cannot be disabled for regulated data
70
+ - **Audit logging is immutable** - All security events are permanently logged
71
+
72
+ ### Migration Notes
73
+ - **From OpenLIT**: Security features are now mandatory and cannot be disabled
74
+ - **From other SDKs**: All operations now include automatic security scanning
75
+ - **Enterprise deployments**: Additional compliance and governance features available
76
+
77
+ ### Documentation
78
+ - **Security First Guide** - Understanding Sector8's security architecture
79
+ - **Enterprise Guide** - Enterprise deployment patterns and best practices
80
+ - **Platform Overview** - Comprehensive platform capabilities and features
81
+ - **Compliance Guide** - Meeting compliance requirements and regulations
82
+ - **API Reference** - Complete API documentation and examples
83
+ - **Migration Guide** - Migrating from other SDKs and platforms
84
+
85
+ ### Examples
86
+ - **Basic usage** - Simple integration with automatic security
87
+ - **Enterprise deployment** - Multi-tenant, compliance-ready deployment
88
+ - **Security testing** - Testing security features and violation handling
89
+ - **Model monitoring** - AI model monitoring and governance examples
90
+ - **Compliance automation** - Automated compliance validation and reporting
91
+
92
+ ### Support
93
+ - **Documentation**: [docs.sector8.com](https://docs.sector8.com)
94
+ - **Security Issues**: [security@sector8.com](mailto:security@sector8.com)
95
+ - **General Support**: [support@sector8.com](mailto:support@sector8.com)
96
+ - **Discord**: [Join our community](https://discord.gg/sector8)
97
+
98
+ ---
99
+
100
+ ## [Unreleased]
101
+
102
+ ### Added
103
+ - SDK-specific `.env.example` file for easier environment configuration
104
+ - Streamlined 3-line setup documentation in README
105
+ - Improved quickstart examples with decorator pattern
106
+
107
+ ### Changed
108
+ - Package name consistency: use `sector8` instead of `sector8-sdk` for pip install
109
+ - Simplified installation instructions
110
+ - Updated README structure for better developer experience
111
+
112
+ ### Fixed
113
+ - Documentation links and references
114
+ - Environment setup instructions
115
+
116
+ ## [1.0.1] - 2025-01-21
117
+
118
+ ### Added
119
+ - Enhanced documentation with clearer setup instructions
120
+ - SDK-specific environment configuration
121
+ - Improved testing documentation
122
+
123
+ ### Changed
124
+ - Streamlined README for better developer onboarding
125
+ - Updated installation and setup process
126
+
127
+ ### Fixed
128
+ - Package name inconsistencies in documentation
129
+
130
+ ### Planned Features
131
+ - **Advanced threat intelligence** - Integration with threat intelligence feeds
132
+ - **Behavioral analysis** - User and system behavior analysis
133
+ - **Automated response** - Automated security incident response
134
+ - **Advanced compliance** - Additional compliance frameworks and regulations
135
+ - **Cloud integration** - Enhanced cloud provider integration
136
+ - **Mobile support** - Mobile application security and monitoring
137
+ - **IoT security** - Internet of Things security monitoring
138
+ - **Blockchain integration** - Blockchain-based audit logging and verification
139
+
140
+ ### Security Enhancements
141
+ - **Quantum-resistant cryptography** - Post-quantum cryptography support
142
+ - **Advanced anomaly detection** - Machine learning-based anomaly detection
143
+ - **Threat hunting** - Proactive threat hunting capabilities
144
+ - **Incident response automation** - Automated incident response workflows
145
+ - **Security orchestration** - Security orchestration and automation
146
+
147
+ ### Observability Enhancements
148
+ - **Advanced analytics** - Advanced analytics and machine learning insights
149
+ - **Custom dashboards** - Customizable dashboards and visualizations
150
+ - **Real-time streaming** - Real-time data streaming and processing
151
+ - **Advanced alerting** - Advanced alerting and notification systems
152
+ - **Performance optimization** - Performance optimization and tuning
153
+
154
+ ### Intelligence Enhancements
155
+ - **Advanced AI models** - Support for advanced AI models and frameworks
156
+ - **Federated learning** - Federated learning and privacy-preserving AI
157
+ - **Edge AI** - Edge AI and distributed intelligence
158
+ - **AutoML** - Automated machine learning and model optimization
159
+ - **AI ethics** - AI ethics and responsible AI features
160
+
161
+ ---
162
+
163
+ ## Version History
164
+
165
+ - **1.0.0** - Initial release with comprehensive security, observability, and intelligence features
166
+ - **Unreleased** - Future releases with advanced features and enhancements
167
+
168
+ ---
169
+
170
+ **Sector8-sdk** - Where AI Security Meets Observability
171
+
172
+ > **Remember**: Security is not an add-on feature—it's the foundation of the SDK that cannot be removed or bypassed.
@@ -0,0 +1,175 @@
1
+ # Contributing to Sector8 SDK
2
+
3
+ Thank you for your interest in contributing to the Sector8 SDK! This document provides guidelines and information for contributors.
4
+
5
+ ## Getting Started
6
+
7
+ ### Prerequisites
8
+
9
+ - Python 3.8 or higher
10
+ - Git
11
+ - pip or conda for package management
12
+
13
+ ### Development Setup
14
+
15
+ 1. **Clone the repository:**
16
+ ```bash
17
+ git clone https://github.com/sector8/sector8-sdk.git
18
+ cd sector8-sdk
19
+ ```
20
+
21
+ 2. **Create a virtual environment:**
22
+ ```bash
23
+ python -m venv venv
24
+ source venv/bin/activate # On Windows: venv\Scripts\activate
25
+ ```
26
+
27
+ 3. **Install development dependencies:**
28
+ ```bash
29
+ pip install -e ".[dev]"
30
+ ```
31
+
32
+ 4. **Install pre-commit hooks:**
33
+ ```bash
34
+ pre-commit install
35
+ ```
36
+
37
+ ## Development Guidelines
38
+
39
+ ### Code Style
40
+
41
+ We use several tools to maintain code quality:
42
+
43
+ - **Black** for code formatting
44
+ - **isort** for import sorting
45
+ - **mypy** for type checking
46
+ - **ruff** for linting
47
+
48
+ Run these tools before committing:
49
+
50
+ ```bash
51
+ black src/ tests/
52
+ isort src/ tests/
53
+ mypy src/
54
+ ruff check src/ tests/
55
+ ```
56
+
57
+ ### Testing
58
+
59
+ We use pytest for testing. Run tests with:
60
+
61
+ ```bash
62
+ # Run all tests
63
+ pytest
64
+
65
+ # Run with coverage
66
+ pytest --cov=sector8
67
+
68
+ # Run specific test file
69
+ pytest tests/test_client.py
70
+
71
+ # Run with verbose output
72
+ pytest -v
73
+ ```
74
+
75
+ ### Type Hints
76
+
77
+ All new code should include type hints. We use mypy for type checking:
78
+
79
+ ```bash
80
+ mypy src/
81
+ ```
82
+
83
+ ### Documentation
84
+
85
+ - Update docstrings for any new functions or classes
86
+ - Follow Google-style docstrings
87
+ - Include type information in docstrings
88
+
89
+ Example:
90
+ ```python
91
+ def process_data(data: List[str], config: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
92
+ """Process the input data according to configuration.
93
+
94
+ Args:
95
+ data: List of strings to process
96
+ config: Optional configuration dictionary
97
+
98
+ Returns:
99
+ Dictionary containing processed results
100
+
101
+ Raises:
102
+ ValueError: If data is empty
103
+ """
104
+ ```
105
+
106
+ ## Pull Request Process
107
+
108
+ 1. **Create a feature branch:**
109
+ ```bash
110
+ git checkout -b feature/your-feature-name
111
+ ```
112
+
113
+ 2. **Make your changes** following the guidelines above
114
+
115
+ 3. **Run tests and quality checks:**
116
+ ```bash
117
+ pytest
118
+ mypy src/
119
+ black --check src/ tests/
120
+ ruff check src/ tests/
121
+ ```
122
+
123
+ 4. **Commit your changes:**
124
+ ```bash
125
+ git add .
126
+ git commit -m "feat: add new feature description"
127
+ ```
128
+
129
+ 5. **Push to your fork:**
130
+ ```bash
131
+ git push origin feature/your-feature-name
132
+ ```
133
+
134
+ 6. **Create a Pull Request** with a clear description of your changes
135
+
136
+ ### Commit Message Format
137
+
138
+ We follow conventional commit format:
139
+
140
+ - `feat:` for new features
141
+ - `fix:` for bug fixes
142
+ - `docs:` for documentation changes
143
+ - `style:` for formatting changes
144
+ - `refactor:` for code refactoring
145
+ - `test:` for test changes
146
+ - `chore:` for maintenance tasks
147
+
148
+ ## Issue Reporting
149
+
150
+ When reporting issues, please include:
151
+
152
+ - Python version
153
+ - Operating system
154
+ - SDK version
155
+ - Steps to reproduce
156
+ - Expected vs actual behavior
157
+ - Error messages or logs
158
+
159
+ ## Security
160
+
161
+ If you discover a security vulnerability, please report it privately to security@sector8.com.
162
+
163
+ ## License
164
+
165
+ By contributing to Sector8 SDK, you agree that your contributions will be licensed under the MIT License.
166
+
167
+ ## Questions?
168
+
169
+ If you have questions about contributing, please:
170
+
171
+ 1. Check the existing documentation
172
+ 2. Search existing issues
173
+ 3. Create a new issue with the "question" label
174
+
175
+ Thank you for contributing to Sector8 SDK!
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Sector8
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,43 @@
1
+ # Include package metadata
2
+ include README.md
3
+ include LICENSE
4
+ include CHANGELOG.md
5
+ include CONTRIBUTING.md
6
+ include TESTING_PUBLIC.md
7
+ include requirements.txt
8
+
9
+ # Exclude sensitive files from distribution
10
+ exclude TESTING.md
11
+ exclude PRODUCTION_READINESS_CHECKLIST.md
12
+ exclude TESTING_SETUP_COMPLETE.md
13
+ exclude CREATE_DIST_MANUAL.md
14
+ exclude .env.example
15
+ exclude setup_clean_env.sh
16
+ exclude run_full_test_suite.sh
17
+ exclude build_package.sh
18
+ exclude validate_sdk_structure.py
19
+
20
+ # Include all Python files
21
+ recursive-include src/sector8 *.py
22
+ recursive-include src/sector8 *.pyi
23
+
24
+ # Include configuration files
25
+ include src/sector8/py.typed
26
+
27
+ # Exclude development and test files
28
+ exclude test_*.py
29
+ exclude *_test.py
30
+ recursive-exclude * __pycache__
31
+ recursive-exclude * *.py[co]
32
+ recursive-exclude * .git*
33
+ recursive-exclude * .DS_Store
34
+ recursive-exclude * *.egg-info
35
+
36
+ # Include auto-instrumentation files
37
+ recursive-include src/sector8/instrumentation *.py
38
+
39
+ # Include all module data
40
+ recursive-include src/sector8 *.json
41
+ recursive-include src/sector8 *.yaml
42
+ recursive-include src/sector8 *.yml
43
+ recursive-include src/sector8 *.toml