Skip to main content

A terminal weather tool with industrial aesthetic, focusing on Real Feel and Windchill.

Project description

Isobar CLI

CI Coverage PyPI version Version Ruff Python License Security Scan

A terminal weather tool designed to provide a fast, clean sense of what the weather feels like outside; right now and for the week ahead. Built with Python and Rich.

Philosophy

Isobar CLI answers a simple question: "What does it feel like outside right now, and do I need a jacket?"

Most weather apps overwhelm with data. Isobar strips away everything except what matters when deciding how to prepare for the day.

Design Principles

  • Essential over comprehensive — Show Real Feel, not 47 data points.
  • Terminal-native — Built for quick checks within a developer workflow.
  • Zero friction — No API keys or configuration files required.
  • Information density — Industrial dashboard UI for maximum readability.
  • Intentional features — Each feature must answer: "Does this help someone understand what it feels like outside?"
  • Distinctive aesthetic — Retro-futuristic industrial styling that avoids generic "AI slop"

✨ Features

  • Industrial Aesthetic — Retro-futuristic weather observatory dashboard with brutalist styling 🏭
  • Auto-Locationisobar detects the city automatically 🌍
  • Weather Condition Icons — WMO-standard emoji + plain-English description (☀️ Clear sky, 🌨️ Moderate snow, ⛈️ Thunderstorm)
  • Real Feel — Apparent temperature metrics (what it actually feels like).
  • Air Quality Index — US AQI with health classifications 😷
  • 7-Day Forecast — Full week outlook with color-coded highs/lows and daily rain %
  • Hourly Outlook — Next 12 hours of temperature and rain chance (--hourly)
  • Multiple Cities — Compare weather across several cities side-by-side.
  • Smart Suggestions — Fuzzy city name matching if there is a typo.
  • Shell Completion — Tab-complete city names based on search history.
  • Dynamic Timezone — Sunrise/sunset shown in the city's local time, not yours.
  • Precipitation Forecast — Next 6h rain/snow chance and totals.
  • Smart Caching — 15-minute cache per city (~/.cache/isobar/)
  • Color-Coded Temps — Intuitive color mapping for temperature ranges.
  • Metric Support--metric or -m for Celsius, km/h, and mm.
  • No API Keys — Free Open-Meteo and ip-api.com.
  • Zero Config — Works instantly after installation.
  • Visual Gauges — Temperature and humidity gauge visualizations 📊
  • Severity Indicators — Weather condition severity icons (⚡, ▲, ●, ○, ◇)
  • Wind Categories — Descriptive wind speed classifications (CALM, LIGHT, GENTLE, etc.)
  • Industrial Styling — Heavy borders, uppercase labels, status columns
  • Phase 7: Intuition & Analysis — Higher-level context and automated insights:
    • Preparation Guidance — Clothing and gear suggestions with priority levels 🧥☂️🧴
    • Temporal Context — Comparison with previous day conditions 📈
    • UV Index Monitoring — Sun protection guidance with intensity levels ☀️
    • Wind Gust Alerts — Highlighting of significant gust events 💨⚠️
    • Home City Persistence — Set a default city with isobar home "Your City" 🏠 (Note: Due to a Typer limitation, this currently shows weather for "Home, Kansas" instead of setting home city. Manual config editing required.)

🚀 Installation

The recommended way to install Isobar is via pipx:

pipx install isobar-cli

Installation is also supported via Homebrew:

brew install KnowOneActual/tap/isobar

Note: Installing via Homebrew builds several high-performance dependencies (like numpy and h3) from source. This ensures a robust, isolated install but may take 5-10 minutes to complete.

Alternatively, install directly from PyPI:

pip install isobar-cli

Or install from source:

git clone https://github.com/KnowOneActual/isobar-cli.git
cd isobar-cli
pip install .

📱 Usage

# Auto-detect location
isobar

# Specify a city
isobar Chicago
isobar London Tokyo Paris     # Multiple cities
isobar "New York"             # Use quotes for multi-word cities

# Hourly outlook (next 12h)
isobar --hourly Chicago
isobar -H Chicago

# 7-day forecast
isobar --forecast Chicago
isobar -f Chicago

# Note: Flags must come before city names
# ✅ isobar -H Chicago
# ❌ isobar Chicago -H  (treats "-H" as a city name)
isobar "San Francisco" --forecast
isobar -f Sydney

# Metric units (Celsius, km/h, mm)
isobar --metric
isobar -m
isobar Tokyo -m

# Home city management
isobar home "New York"    # Set home city
isobar home               # Show current home city
isobar home --clear       # Clear home city
isobar                    # Uses home city if set (otherwise auto-detects)

⚙️ Configuration

Isobar supports configuration via environment variables for advanced use cases:

API Endpoint Configuration

Customize API endpoints for different weather providers or testing:

# Use custom weather APIs
export ISOBAR_GEOCODING_URL="https://custom-geocoding-api.example.com/v1/search"
export ISOBAR_WEATHER_URL="https://custom-weather-api.example.com/v1/forecast"
export ISOBAR_AQI_URL="https://custom-aqi-api.example.com/v1/air-quality"

# Run with custom endpoints
isobar "New York"

Timezone Support

For enhanced timezone accuracy (optional):

# Install optional timezone support
pip install isobar-cli[timezone]

# Sunrise/sunset will now display in local timezone
isobar London

Debug Mode

Enable debug logging to stderr:

# View API errors and debugging information
isobar "Test City" 2> debug.log

⌨️ Shell Completion

Isobar supports tab-completion for city names. To enable it for a shell:

Zsh:

isobar --install-completion zsh

Bash:

isobar --install-completion bash

(Note: A terminal restart may be required after installation).

🖥️ Example Output

Industrial Aesthetic (v1.3.0+)

┌─ WEATHER OBSERVATORY ─┐
CHICAGO
┌─────┬──────────────────────┬────────────────┬────────────────┐
│     │ METRIC               │ READING        │ STATUS         │
├─────┼──────────────────────┼────────────────┼────────────────┤
│ ☀️  │ CONDITIONS           │ MAINLY CLEAR   │ ◇              │
│ 🌡️  │ TEMPERATURE          │ 75.2°F         │ [███░░░░░░░]   │
│ 🤔  │ REAL FEEL            │ 78.5°F         │ ▲ 3.3°F        │
│ 💨  │ WIND SPEED           │ 12.4 mph       │ GENTLE         │
│ 💧  │ HUMIDITY             │ 65%            │ [▓▓▓░░]        │
│ 😷  │ AIR QUALITY          │ 45             │ GOOD ◇         │
│ ☔  │ PRECIPITATION         │ 30% (6h)       │ [▓░░]          │
│     │ FORECAST             │ LIGHT RAIN LIKELY │               │
│ 🌅  │ SUNRISE              │ 06:29          │ DAWN           │
│ 🌇  │ SUNSET               │ 17:37          │ DUSK           │
│ ☀️  │ UV INDEX             │ 6.5            │ HIGH ☀️☀️☀️     │
│ ⚡  │ GUST ALERT           │ 25 mph         │ ⚠️ SEVERE       │
└─────┴──────────────────────┴────────────────┴────────────────┘

┌─ TREND ANALYSIS ─┐
↑ 5.2°F WARMER THAN YESTERDAY
└──────────────────┘

┌─ PREPARATION PROTOCOL ─┐
  ⚠️  HIGH PRIORITY
    ▶ Wind gusts up to 25 mph - secure loose items
  ▲  RECOMMENDED
    ▶ Light jacket recommended
    ▶ Sunscreen recommended (UV: High)
  ○  ADVISORY
    ▶ Sunglasses recommended for glare
└─────────────────────────┘

┌─ FORECAST PANEL ─┐
CHICAGO
┌──────┬──┬────────────────────┬───────┬───────┬───────┬────────┐
│ DAY  │  │ CONDITIONS         │ HIGH  │ LOW   │ RAIN% │ STATUS │
├──────┼──┼────────────────────┼───────┼───────┼───────┼────────┤
│ TODAY│☀️│ MAINLY CLEAR       │ 78.7°F│ 63.9°F│ 30%   │ ○      │
│ TUE  │⛅│ PARTLY CLOUDY      │ 82.4°F│ 65.4°F│ 20%   │ ○      │
│ WED  │🌦️│ LIGHT DRIZZLE      │ 76.8°F│ 60.9°F│ 45%   │ ●      │
│ THU  │☀️│ CLEAR SKY          │ 80.3°F│ 63.5°F│ 10%   │ ○      │
└──────┴──┴────────────────────┴───────┴───────┴───────┴────────┘

## 🛠 Tech Stack

| Tool | Purpose |
|---|---|
| [Typer](https://typer.tiangolo.com/) | CLI framework |
| [Rich](https://github.com/Textualize/rich) | Terminal UI |
| [Open-Meteo](https://open-meteo.com/) | Weather and forecast data |
| [ipwho.is](https://ipwho.is/) | Auto-location detection |
| [timezonefinder](https://github.com/jannikmi/timezonefinder) | Dynamic timezone resolution |
| [pytest](https://docs.pytest.org/) | Unit testing framework |
| [requests-mock](https://requests-mock.readthedocs.io/) | API testing |
| [Ruff](https://docs.astral.sh/ruff/) | Linting and formatting |
| [pip-audit](https://github.com/pypa/pip-audit) | Dependency security scanning |
| **Phase 7 Features** | **Intuition & Analysis** |
| `config.py` | Persistent home city configuration |
| Enhanced `logic.py` | Preparation guidance, UV monitoring, gust alerts |
| Updated `ui.py` | Contextual display of insights |
| **v1.2.0 Features** | **Security & Configuration** |
| Configurable API Endpoints | Environment variable support for custom APIs |
| Enhanced Error Handling | Specific exception catching with timeouts |
| Timezone Support | Optional `pytz` dependency for local time display |
| **v1.3.0 Features** | **Industrial Aesthetic** |
| Industrial UI Design | Retro-futuristic weather observatory dashboard |
| Visual Gauges | Temperature and humidity gauge visualizations |
| Severity Indicators | Weather condition severity classification |
| Enhanced Typography | Heavy borders, uppercase labels, status columns |

## 🔒 Security

Security is a fundamental priority for Isobar CLI. Multiple layers of automated scanning ensure the tool remains safe and secure for all users.

### Security Measures
- **Vulnerability Scanning:** [Trivy](https://github.com/aquasecurity/trivy) scans the filesystem and dependencies for known vulnerabilities.
- **Static Analysis (SAST):** [Bandit](https://github.com/PyCQA/bandit) and [Semgrep](https://semgrep.dev/) analyze the code for insecure patterns.
- **Dependency Auditing:** [pip-audit](https://github.com/pypa/pip-audit) and GitHub Dependabot ensure third-party packages stay updated.
- **Script Linting:** [ShellCheck](https://www.shellcheck.net/) enforces best practices for Bash scripts.
- **Secret Scanning:** Automated checks prevent the accidental commitment of sensitive credentials.

All security scans are integrated into the CI/CD pipeline and run on every push, pull request, and weekly schedule. Results are available via the GitHub Security tab.

## 📈 Project Status

✅ **Phase 1 Complete** — Caching and Auto-Location  
✅ **Phase 2 Complete** — Precipitation, Sunrise/Sunset, and Condition Icons  
✅ **Phase 3 Complete** — 7-Day Forecast, Dynamic Timezone, and UI Refinements  
✅ **Phase 4 Complete** — Quality & Trust (Security, CI/CD)  
✅ **Phase 5 Complete** — Testing & Reliability  
✅ **Phase 6 Complete** — Distribution (PyPI, Homebrew)  
✅ **Phase 7 Complete** — Intuition & Analysis (v1.1.0)  
✅ **v1.2.0 Complete** — Security & Configuration Enhancements  
Refer to [ROADMAP.md](ROADMAP.md) and [CHANGELOG.md](CHANGELOG.md) for details.

## 🤝 Contributing

Detailed instructions are available in [CONTRIBUTING.md](CONTRIBUTING.md). New features must answer: **"Does this help someone understand what it feels like outside?"**

## 📄 License

MIT. See [LICENSE](LICENSE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

isobar_cli-1.3.2.tar.gz (33.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

isobar_cli-1.3.2-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file isobar_cli-1.3.2.tar.gz.

File metadata

  • Download URL: isobar_cli-1.3.2.tar.gz
  • Upload date:
  • Size: 33.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for isobar_cli-1.3.2.tar.gz
Algorithm Hash digest
SHA256 77b34ca9e8c3ad92491fa0e54dd4b0a432db43aa0b4f4095bae3116cac562eae
MD5 383d6c2838991e2d99cf763d1b3836c1
BLAKE2b-256 5e39068c2ae082dee0c02d92654970e0b47469fdf23ff096f0be4ba900f43f36

See more details on using hashes here.

Provenance

The following attestation bundles were made for isobar_cli-1.3.2.tar.gz:

Publisher: publish.yml on KnowOneActual/isobar-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file isobar_cli-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: isobar_cli-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for isobar_cli-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f7f61a5f7037d704b113cb165b505820a117747cf32beb92e28340598f5475f2
MD5 13d8932014acf8cbe8762f6a190a028b
BLAKE2b-256 68546322c7d32ccba11bbddcbc6650233bef57446cb327634eeb4508e87f4398

See more details on using hashes here.

Provenance

The following attestation bundles were made for isobar_cli-1.3.2-py3-none-any.whl:

Publisher: publish.yml on KnowOneActual/isobar-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page