sucolo-database-services

Sucolo Database Services

A Python package providing database services for the Sucolo project, including Elasticsearch and Redis clients with additional utilities for data processing and analysis.

Features

• Elasticsearch client integration
• Redis client integration
• Data processing utilities
• H3 geospatial indexing support
• Type-safe data handling with Pydantic

Requirements

• Python 3.10, 3.11, 3.12, 3.13
• Poetry for dependency management

Installation

• Clone the repository:

git clone https://github.com/yourusername/sucolo-database_services.git
cd sucolo-database_services

• Install dependencies using Poetry:

poetry install

• Set up your environment variables in .env file:

# Example .env configuration
ELASTICSEARCH_HOST=localhost
ELASTICSEARCH_PORT=9200
REDIS_HOST=localhost
REDIS_PORT=6379

Development

Code Style

This project uses several tools to maintain code quality:

• Black for code formatting
• Flake8 for linting
• MyPy for type checking
• isort for import sorting

Run the following command to format and check the code:

make format

Testing

Run tests using pytest:

make test

Project Structure

sucolo_database_services/
├── elasticsearch_client/     # Elasticsearch client implementation
├── redis_client/             # Redis client implementation
├── services/                 # Service layer (feature, metadata, management, etc.)
├── utils/                    # Utility functions and helpers
├── tests/                    # Test suite for all services and modules
├── data_access.py            # Aggregated data access layer
└── __init__.py

Dependencies

Main dependencies:

• elasticsearch
• redis
• pandas
• geopandas
• h3
• pydantic
• python-dotenv

License

[Add your license information here]

Contributing

[Add contribution guidelines here]