Metadata-Version: 2.4
Name: citypulse
Version: 0.1.0
Summary: Real-time city energy scores for Indian cities
Author: Jagriti Singh
License: MIT
Project-URL: Homepage, https://project-s9n4g.vercel.app
Project-URL: Repository, https://github.com/jagzgotspark/City-Pulse
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.28.0

# citypulse

Real-time city energy scores for Indian cities.

## Install

```bash
pip install citypulse
```

## Usage

```python
from citypulse import CityPulse

cp = CityPulse()

# Get pulse score for any city
print(cp.get_pulse("Mumbai"))
# → {"city": "Mumbai", "pulse_score": 83.9, "temperature": 30.4, ...}

# Live leaderboard
cities = cp.get_dashboard()
for c in cities:
    print(f"{c['city']}: {c['pulse_score']}/100")

# Similar cities
similar = cp.get_similar("Bengaluru")
# → [{"city": "Mumbai", "similarity_score": 0.87, ...}]

# Neighbourhood breakdown
areas = cp.get_neighbourhood("Lucknow")
# → [{"neighbourhood": "Hazratganj", "pulse_score": 51.1, ...}]
```

## API

| Method | Description |
|---|---|
| `get_pulse(city)` | Latest pulse score for any city |
| `get_dashboard()` | All tracked cities with scores |
| `get_trend(city, days=7)` | Hourly pulse trend |
| `get_forecast(city)` | 24h Prophet forecast |
| `get_similar(city)` | Cities with similar vibe |
| `get_neighbourhood(city)` | Area-level scores |
| `compare(days=7)` | City ranking |
