reten-service-core 0.1.0

Core library providing common components and utilities for Reten microservices

Reten Service Core Library

Core library providing common components and utilities for Reten microservices.

Features

• Authentication: API Key and JWT authentication
• Logging: Structured logging configuration
• Monitoring: Metrics and distributed tracing
• Storage: Database clients (BigQuery, Redis)
• Testing: Common fixtures and mocks
• Utilities: Common helper functions

Installation

pip install reten-service-core

For development:

pip install reten-service-core[dev]

Quick Start

from fastapi import FastAPI
from reten_service_core import APIKeyAuth
from reten_service_core.logging import configure_logging
from reten_service_core.monitoring import metrics

# Configure logging
configure_logging()

# Create FastAPI app with auth
app = FastAPI()
app.include_middleware(APIKeyAuth)

# Add metrics
@app.get("/")
@metrics.track_latency()
async def root():
    return {"message": "Hello World"}

Development

1. Clone the repository:

   git clone [e-mail]:reten/service-core.git
   cd service-core
   

2. Create and activate virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. Install development dependencies:

   pip install -e ".[dev]"
   

4. Run tests:

   pytest
   

Contributing

We welcome contributions to the Reten Service Core library! Whether it's:

• 🐛 Bug fixes
• ✨ New features
• 📚 Documentation improvements
• 🧪 Additional tests
• 🔧 Infrastructure updates

Quick Start

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run quality checks:

   # Run tests
   pytest
   
   # Run linting
   ruff check .
   ruff format .
   

5. Commit your changes (using Conventional Commits)
6. Push to your fork
7. Open a Pull Request

Development Environment

See the Development section above for basic setup instructions.

Detailed Guidelines

For detailed information about:

• Code style and standards
• Testing requirements
• Pull request process
• Development environment setup
• Commit message conventions

Please read our Contributing Guide.

Need Help?

• 📖 Check the examples directory for usage examples
• 🤔 Open an issue for questions or problems
• 💬 Contact the maintainers at [e-mail]

License

This project is licensed under the MIT License - see the LICENSE file for details.

What does this mean?

• ✅ Commercial use
• ✅ Modification
• ✅ Distribution
• ✅ Private use
• ⚠️ No liability
• ⚠️ No warranty

The MIT License is a permissive license that allows you to do anything you want with the code as long as you include the original copyright and license notice in any copy of the software/source.