https://github.com/buried-in-code/weatherdan

Retrieve weather information from Ecowitt devices and display in graphs.
https://github.com/buried-in-code/weatherdan

csv ecowitt fastapi hatch hatchling python python-3

Last synced: about 2 months ago
JSON representation

Retrieve weather information from Ecowitt devices and display in graphs.

• Host: GitHub
• URL: https://github.com/buried-in-code/weatherdan
• Owner: Buried-In-Code
• License: mit
• Created: 2022-10-12T02:36:56.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T20:54:10.000Z (4 months ago)
• Last Synced: 2024-10-16T22:48:19.190Z (2 months ago)
• Topics: csv, ecowitt, fastapi, hatch, hatchling, python, python-3
• Language: Python
• Homepage:
• Size: 238 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Weatherdan

![Python](https://img.shields.io/badge/Python-3.11-green?style=flat-square)

![Status](https://img.shields.io/badge/Status-Beta-yellowgreen?style=flat-square)

[![Rye](https://img.shields.io/badge/Rye-informational?style=flat-square&logo=rye&labelColor=grey)](https://rye.astral.sh)

[![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)

[![Ruff](https://img.shields.io/badge/Ruff-informational?style=flat-square&logo=ruff&labelColor=grey)](https://github.com/astral-sh/ruff)

[![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)

[![Github - License](https://img.shields.io/github/license/Buried-In-Code/Weatherdan?logo=Github&label=License&style=flat-square)](https://opensource.org/licenses/MIT)

[![Github - Contributors](https://img.shields.io/github/contributors/Buried-In-Code/Weatherdan?logo=Github&label=Contributors&style=flat-square)](https://github.com/Buried-In-Code/Weatherdan/graphs/contributors)

Retrieve weather information from Ecowitt devices and display in graphs, allows for manual additions and updates.\

Currently, tracks total Rainfall and high, average and low for Solar, UV Index and Wind readings.

## Usage

### via Pip

1. Make sure you have a supported version of [Python](https://www.python.org/) installed: `python --version`

2. Clone the repo: `git clone https://github.com/Buried-In-Code/Weatherdan`

3. Install the project: `pip install .`

4. Run using: `Weatherdan`

### via Pipx

1. Make sure you have [Pipx](https://github.com/pypa/pipx) installed: `pipx --version`

2. Install the project `pipx install git+https://github.com/Buried-In-Code/Weatherdan.git`

3. Run using: `Weatherdan`

### via Docker-Compose

1. Make sure you have [Docker](https://www.docker.com/) installed: `docker --version`

2. Make sure you have [Docker-Compose](https://github.com/docker/compose) installed: `docker-compose --version`

3. Create a `docker-compose.yaml` file, _an example:_

```yaml

version: '3'

services:

  weatherdan:

    image: 'ghcr.io/buried-in-code/weatherdan:latest'

    container_name: 'Weatherdan'

    environment:

      TZ: 'Pacific/Auckland'

    ports:

      - '25710:25710'

    volumes:

      - './config:/app/config'

      - './data:/app/data'

```

4. Run using: `docker-compose up -d`

## Socials

[![Social - Fosstodon](https://img.shields.io/badge/%40BuriedInCode-teal?label=Fosstodon&logo=mastodon&style=for-the-badge)](https://fosstodon.org/@BuriedInCode)\

[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)