mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 05:13:40 +00:00
a90fef6f2d
Major restructuring of the scripts/ directory with consistent output
formatting, improved organization, and stricter error handling.
Breaking Changes:
- Updated development environment to Home Assistant 2025.7+
- Removed Python 3.12 compatibility (HA 2025.7+ requires Python 3.13)
- Updated all HA core requirements from 2025.7 requirement files
- Added new dependencies: python-multipart, uv (for faster package management)
- Updated GitHub Actions workflows to use Python 3.13
Changes:
- Created centralized output library (scripts/.lib/output.sh)
- Unified color codes and Unicode symbols
- Consistent formatting functions (log_header, log_success, log_error, etc.)
- Support for embedded formatting codes (${BOLD}, ${GREEN}, etc.)
- Reorganized into logical subdirectories:
- scripts/setup/ - Setup and maintenance scripts
- bootstrap: Install/update dependencies (used in CI/CD)
- setup: Full DevContainer setup (pyright, copilot, HACS)
- reset: Reset config/ directory to fresh state (NEW)
- sync-hacs: Sync HACS integrations
- scripts/release/ - Release management scripts
- prepare: Version bump and tagging
- suggest-version: Semantic version suggestion
- generate-notes: Release notes generation
- check-if-released: Check release status
- hassfest: Local integration validation
- Updated all scripts with:
- set -euo pipefail for stricter error handling
- Consistent SCRIPT_DIR pattern for reliable sourcing
- Professional output with colors and emojis
- Unified styling across all 17 scripts
- Removed redundant scripts:
- scripts/update (was just wrapper around bootstrap)
- scripts/json_schemas/ (moved to schemas/json/)
- Enhanced clean script:
- Improved artifact cleanup
- Better handling of accidental package installations
- Hints for reset and deep clean options
- New reset script features:
- Standard mode: Keep configuration.yaml
- Full mode (--full): Reset configuration.yaml from git
- Automatic re-setup after reset
- Updated documentation:
- AGENTS.md: Updated script references and workflow guidance
- docs/development/: Updated all references to new script structure
Impact: Development environment now requires Python 3.13 and Home Assistant
2025.7+. Developers get consistent, professional script output with better
error handling and logical organization. Single source of truth for styling
makes future updates trivial.
57 lines
1.2 KiB
Markdown
57 lines
1.2 KiB
Markdown
# Development Setup
|
|
|
|
> **Note:** This guide is under construction. For now, please refer to [`AGENTS.md`](../../AGENTS.md) for detailed setup information.
|
|
|
|
## Prerequisites
|
|
|
|
- VS Code with Dev Container support
|
|
- Docker installed and running
|
|
- GitHub account (for Tibber API token)
|
|
|
|
## Quick Setup
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://github.com/jpawlowski/hass.tibber_prices.git
|
|
cd hass.tibber_prices
|
|
|
|
# Open in VS Code
|
|
code .
|
|
|
|
# Reopen in DevContainer (VS Code will prompt)
|
|
# Or manually: Ctrl+Shift+P → "Dev Containers: Reopen in Container"
|
|
```
|
|
|
|
## Development Environment
|
|
|
|
The DevContainer includes:
|
|
|
|
- Python 3.13 with `.venv` at `/home/vscode/.venv/`
|
|
- `uv` package manager (fast, modern Python tooling)
|
|
- Home Assistant development dependencies
|
|
- Ruff linter/formatter
|
|
- Git, GitHub CLI, Node.js, Rust toolchain
|
|
|
|
## Running the Integration
|
|
|
|
```bash
|
|
# Start Home Assistant in debug mode
|
|
./scripts/develop
|
|
```
|
|
|
|
Visit http://localhost:8123
|
|
|
|
## Making Changes
|
|
|
|
```bash
|
|
# Lint and format code
|
|
./scripts/lint
|
|
|
|
# Check-only (CI mode)
|
|
./scripts/lint-check
|
|
|
|
# Validate integration structure
|
|
./scripts/release/hassfest
|
|
```
|
|
|
|
See [`AGENTS.md`](../../AGENTS.md) for detailed patterns and conventions.
|