Add Configuration Documentation and Examples for CoinGecko API Integration

[TestingRabbit-pixel]

Add Configuration Documentation and Examples for CoinGecko API Integration

Description

Task

Add configuration documentation and example

Acceptance Criteria

• Comprehensive .env.example file
• Fully documented configuration class
• Flexible configuration loading mechanism
• Built-in configuration validation
• Support for environment variables
• Programmatic configuration options

Summary of Work

Configuration Documentation

This pull request adds comprehensive documentation and examples for configuring the CoinGecko API integration library.

Configuration Overview

The library supports flexible configuration through environment variables and a config class, allowing developers to easily customize the API integration.

Configuration Options

• COINGECKO_API_KEY: Optional API key for authenticated requests
• COINGECKO_API_BASE_URL: Base URL for CoinGecko API (defaults to official endpoint)
• COINGECKO_REQUEST_TIMEOUT: Timeout for API requests in seconds (default: 10)
• COINGECKO_LOG_LEVEL: Logging level for the application (default: INFO)

Example Usage

# Using environment variables
import os
os.environ['COINGECKO_API_KEY'] = 'your_api_key'
os.environ['COINGECKO_REQUEST_TIMEOUT'] = '15'

# Load configuration
from config.example_config import load_config
config = load_config()

# Programmatic configuration
from config.example_config import CoinGeckoConfig
custom_config = CoinGeckoConfig(
    api_key='your_api_key',
    request_timeout=15,
    log_level='DEBUG'
)

Configuration Validation

The configuration includes built-in validation to ensure:

• Base URL is a valid string
• Request timeout is a positive integer
• Log level is one of the predefined levels

Improvements

• Added comprehensive docstrings
• Implemented configuration validation
• Provided flexible loading mechanism
• Supported both environment and programmatic configuration

Testing Approach

• Verified configuration loading from environment variables
• Tested configuration validation methods
• Ensured default values are correctly applied
• Validated error handling for invalid configurations

Changes Made

• Updated .env.example with clear comments
• Enhanced config/example_config.py with comprehensive configuration handling
• Added docstrings and validation to configuration classes

Tests

• Verify configuration can be loaded from environment variables
• Test configuration validation logic
• Ensure default values are correctly applied
• Check error handling for invalid configurations

Signatures

Staking Key

4dg5biSRX8dyVs9dKjspPid3rgZhs6p3bVSmfX7kii6u: 2TwU6HVMeoN68cbZjSUv41Yzd4VDTCtqagWob1fYNVQWWGiVfp1yxGgwSmCmfNDLUNfhALBEEt7KJzjky1PxxhYi8bVyqsRLcpzxqGAYuJgagxZw6KPE7WtPeEkn9WNHWEYWherVKC7fJ4ysj9tu2T23rG4kohrrgsxHq7cJCYKkkoe6HSz7unrLrZketgQAZ1DtLCMig4RsAiaLuyD1tcfxZ1uLotCbT1raBYh3D54vBU9wK9xgoXpiekd34JbMceiagMZZup4qHaU1HE8qwiy6MidSs64JW1kQvqFEvg1HzYziujTYn4fxMMT1WYx48TSkhK2kC1d4Md3fUmZqfYp31WHZGw3Zp6xm6nfBvsRrDhNZZfVUkG7koFQBNvMTnMWtK9LvbZRtDVFpqzPVVV1ECt8SDrzCXRzGpaRDeZb5Q28

Public Key

8faNomoeXkkduuWjm5qyYJ1E6rg7w5Pzv2Ysj439mwkM: vUuZbLozLWBP74Kq9R2G52ac3gpWVszRSkQe5asmRDXLioeNnYSLAYB6V8jnWHe7q48nUB6gm3dW3GWq4thyzW72QxcawPuJ4cDDAEXqjKGboecK4Qgr9jHMcBVX9TbW5XXub7DrixBtDL9oKLorERMFwEKXav1WRr6KCi9jVVqdMHzox6LKMWr1NS3tJXAeusAahfeBZn6afJLBebXQXL2oVdgBQJmUFexrQmHeCsY6NX2EBzPwyBDbWkCE9CY2PpAvRHz3fG2U8v56hKsuMpW49rxsw8tWwHLemsg6hLZ4KLbn6eDHdMEcd8RHQZLicZvi44pfMo4y9dVNwTFFZWsxrEDvt16aVLpEBF2gRiTyRe797Ysedbwx619umke8oy3NUu5FyRP2oFJWg5YMEW5tKx7cp1n9qQpc6FCdW8uePW