1- <img src =" ./static/img/logo.png " align =" left " width =" 128 " height =" 128 " alt =" Weatherdan Logo " />
2-
31# Weatherdan
42
5- ![ Python] ( https://img.shields.io/badge/Python-3.11 -green?style=flat-square )
3+ ![ Python] ( https://img.shields.io/badge/Python-3.13 -green?style=flat-square )
64![ Status] ( https://img.shields.io/badge/Status-Beta-yellowgreen?style=flat-square )
75
8- [ ![ Rye] ( https://img.shields.io/badge/Rye-informational?style=flat-square&logo=rye&labelColor=grey )] ( https://rye.astral.sh )
9- [ ![ Pre-Commit] ( https://img.shields.io/badge/Pre--Commit-informational?style=flat-square&logo=pre-commit&labelColor=grey )] ( https://github.com/pre-commit/pre-commit )
10- [ ![ Ruff] ( https://img.shields.io/badge/Ruff-informational?style=flat-square&logo=ruff&labelColor=grey )] ( https://github.com/astral-sh/ruff )
6+ [ ![ Pre-Commit] ( https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square )] ( https://github.com/pre-commit/pre-commit )
7+ [ ![ Ruff] ( https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square )] ( https://github.com/astral-sh/ruff )
118
129[ ![ Github - Version] ( https://img.shields.io/github/v/tag/Buried-In-Code/Weatherdan?logo=Github&label=Version&style=flat-square )] ( https://github.com/Buried-In-Code/Weatherdan/tags )
1310[ ![ Github - License] ( https://img.shields.io/github/license/Buried-In-Code/Weatherdan?logo=Github&label=License&style=flat-square )] ( https://opensource.org/licenses/MIT )
@@ -18,20 +15,14 @@ Currently, tracks total Rainfall and high, average and low for Solar, UV Index a
1815
1916## Usage
2017
21- ### via Pip
18+ ### via uv
2219
23- 1 . Make sure you have a supported version of [ Python ] ( https://www.python.org/ ) installed: ` python --version`
20+ 1 . Make sure you have [ uv ] ( https://docs.astral.sh/uv/ ) installed: ` uv --version`
24212 . Clone the repo: ` git clone https://github.com/Buried-In-Code/Weatherdan `
25- 3 . Install the project: ` pip install . `
26- 4 . Run using: ` Weatherdan `
27-
28- ### via Pipx
29-
30- 1 . Make sure you have [ Pipx] ( https://github.com/pypa/pipx ) installed: ` pipx --version `
31- 2 . Install the project ` pipx install git+https://github.com/Buried-In-Code/Weatherdan.git `
32- 3 . Run using: ` Weatherdan `
22+ 3 . Install the project: ` uv sync `
23+ 4 . Run using: ` uv run run.py `
3324
34- ### via Docker- Compose
25+ ### via Docker Compose
3526
36271 . Make sure you have [ Docker] ( https://www.docker.com/ ) installed: ` docker --version `
37282 . Make sure you have [ Docker-Compose] ( https://github.com/docker/compose ) installed: ` docker-compose --version `
@@ -49,8 +40,10 @@ services:
4940 ports :
5041 - ' 25710:25710'
5142 volumes :
43+ - ' ./cache:/app/cache'
5244 - ' ./config:/app/config'
5345 - ' ./data:/app/data'
46+ - ' ./state:/app/state'
5447` ` `
5548
56494. Run using: ` docker-compose up -d`
0 commit comments