mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 05:13:40 +00:00
dff0faeef5
Changed all documentation links from version-specific tags (v0.20.0) to main branch references. This makes documentation maintenance-free - links stay current as code evolves. Updated 38 files across: - docs/developer/docs/ (7 files) - docs/developer/versioned_docs/version-v0.21.0/ (8 files) - docs/developer/versioned_docs/version-v0.22.0/ (8 files) Impact: Documentation links no longer break when new versions are released. Links always point to current code implementation.
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# Development Setup
|
|
|
|
> **Note:** This guide is under construction. For now, please refer to [`AGENTS.md`](https://github.com/jpawlowski/hass.tibber_prices/blob/main/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`](https://github.com/jpawlowski/hass.tibber_prices/blob/main/AGENTS.md) for detailed patterns and conventions.
|