Skip to content

shakedex/hedgebuddy

Repository files navigation

HedgeBuddy

HedgeBuddy

Cross-platform environment variable management for Python scripts without system pollution.

PyPI Python License


What is HedgeBuddy?

HedgeBuddy makes Python automation scripts easy to configure for DIT/Data Wrangling workflows using Hedge's software ecosystem (OffShoot, FoolCat, EditReady):

  1. Python Library (hedgebuddy) - Simple API for reading variables in scripts
  2. Desktop GUI App - Native app for managing variables (Windows & macOS)

HedgeBuddy App


Quick Start

Install

pip install --user hedgebuddy

The desktop app can also install the library for you automatically on first launch.

Download the desktop app from Releases.

Use in Scripts

import hedgebuddy

# Required variable (raises error if not configured)
api_key = hedgebuddy.var("API_KEY")

# Optional variable with fallback
api_url = hedgebuddy.var("API_URL", "https://api.example.com")

# Check if variable exists
if hedgebuddy.exists("PREMIUM_FEATURES"):
    enable_premium()

Key Features

Localized Environment - Variables stored locally, never touch system environment
Cross-Platform - Windows and macOS
Simple Usage in Scripts - Just hedgebuddy.var("NAME")


How It Works

┌─────────────────┐
│   Desktop App   │ ← User manages variables via GUI
└────────┬────────┘
         ↓ Writes to
┌───────────────────────────────┐
│ profiles.json + profiles/*    │ ← Local storage (AppData / Library)
└───────────────┬───────────────┘
         ↓ Reads from
┌─────────────────┐
│ Python Library  │ ← Scripts call hedgebuddy.var()
└─────────────────┘

Storage: %APPDATA%\HedgeBuddy\profiles\<active>\vars.json (Windows) · ~/Library/Application Support/HedgeBuddy/profiles/<active>/vars.json (macOS)


Documentation

Full Documentation


Development

# Python library
cd python-lib && pip install -e . && pytest

# Desktop app
cd app && go run .

Links

PyPI · GitHub · Releases · Issues


HedgeBuddy is an independent, open-source project — not affiliated with Hedge (hedge.co). MIT License.

About

Framework and tool to simplify python script integration and management across Hedge's software suite using python library and GUI app to manage variables

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors