skypulse 1.0.0

Modern Python weather data retrieval library with async support

☀️ SkyPulse

Modern Python Weather Data Package with Async Support

A powerful Python library for weather data retrieval with both synchronous and asynchronous support.

Features • Installation • Quick Start • Documentation • Examples • Contributing

✨ Features

🔄 Modern Python Design

• Full type hints support
• Async and sync operations
• Pydantic data models
• Context managers
• Rich CLI interface

🌡️ Comprehensive Weather Data

• Real-time conditions
• Multi-day forecasts
• Astronomical data
• Location information
• Weather alerts

⚡ Flexible Usage

• Sync/Async operations
• Custom API endpoints
• Format selection (j1/j2)
• Robust error handling
• Progress tracking

🛠️ Developer Experience

• Comprehensive docs
• Type safety
• IDE completion
• Example code
• Testing support

🚀 Installation

📦 From PyPI

pip install skypulse

🔧 Development Installation

git clone https://github.com/HelpingAI/skypulse.git
cd skypulse
pip install -e ".[dev]"

📋 Requirements

• Python 3.7+
• Required packages:
  • requests>=2.28.0
  • aiohttp>=3.8.0
  • pydantic>=1.9.0
  • rich>=12.0.0
  • typer>=0.7.0

📖 Quick Start

🔄 Synchronous Usage

from skypulse import SkyPulse

# Initialize client
client = SkyPulse()

# Get current weather
current = client.get_current("London")
print(f"Temperature: {current.temperature_c}°C")
print(f"Condition: {current.condition.description}")

# Get forecast
forecast = client.get_forecast("London", days=3)
for day in forecast.days:
    print(f"Date: {day.date}, Max: {day.max_temp_c}°C")

⚡ Asynchronous Usage

import asyncio
from skypulse import SkyPulse

async def get_weather():
    async with SkyPulse(async_mode=True) as client:
        # Get current weather
        current = await client.get_current_async("London")
        print(f"Temperature: {current.temperature_c}°C")
        
        # Get forecast
        forecast = await client.get_forecast_async("London", days=3)
        for day in forecast.days:
            print(f"Date: {day.date}, Max: {day.max_temp_c}°C")

# Run async code
asyncio.run(get_weather())

🖥️ CLI Usage

# Get current weather
skypulse "London"

# Get 5-day forecast
skypulse "London" --forecast --days 5

# Get detailed weather with alerts
skypulse "London" --detailed --alerts

# Export weather data to JSON
skypulse "London" --export weather.json

# Simple output format
skypulse "London" --simple

📚 Documentation

🔗 Links

• Official Documentation
• API Reference
• Examples
• FAQ
• GitHub Repository
• PyPI Package
• Release Notes

🎯 Core Features

• Location Support: Search by city name, coordinates, or location ID
• Data Formats: Support for both j1 and j2 API response formats
• Error Handling: Comprehensive error handling with detailed messages
• Rate Limiting: Automatic rate limit handling with retries
• Caching: Optional response caching for improved performance

🔧 Configuration Options

Option	Type	Default	Description
format	str	"j2"	API response format (j1/j2)
async_mode	bool	False	Enable async operations
cache_ttl	int	300	Cache TTL in seconds
timeout	int	10	Request timeout in seconds

🛠️ Advanced Usage

• Custom Endpoints: Configure custom API endpoints
• Proxy Support: HTTP/HTTPS proxy configuration
• Response Parsing: Custom response parsing options
• Retry Strategy: Configurable retry mechanisms

🤝 Contributing

We welcome contributions! Here's how you can help:

1. 🐛 Report Bugs: Open an issue
2. 💡 Suggest Features: Share your ideas in issues
3. 📝 Documentation: Help improve our docs
4. 🔧 Code: Submit pull requests

Please read our Contributing Guide for details.

📊 Project Stats

📅 Release Schedule

• Stable Releases: Every 4-6 weeks
• Bug Fixes: As needed
• Security Updates: Within 48 hours
• View Release History

🔒 Security

Found a security issue? Please report it privately via:

• GitHub Security Advisories
• Email: [e-mail]

📫 Contact

• Discord: Join our community
• Twitter: @HelpingAI
• Email: [e-mail]

---

Made with ❤️ by HelpingAI

HelpingAI License • Code of Conduct • Security Policy

<style> .feature-grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 1rem; margin: 2rem 0; } .feature-item { padding: 1rem; border: 1px solid #e1e4e8; border-radius: 6px; background: #ffffff; } .feature-item h3 { margin-top: 0; color: #0366d6; } .code-examples { margin: 2rem 0; } .documentation { margin: 2rem 0; } .contributing { margin: 2rem 0; } .installation-options { margin: 2rem 0; } </style>