Skip to main content

Offline-first, branch-aware hackathon presentation generator

Project description

HackLuminary v2.2

Offline-first, branch-aware presentation system with a NotebookLM-style local Studio and production deck renderer.

Highlights

  • Hybrid workflow: studio for drafting + generate for exports
  • Source-grounded citations with snippet/line provenance
  • Evidence explorer with search/filter/sort and per-slide evidence pinning
  • Self-contained offline HTML deck output
  • Presenter mode with notes, timer, progress timeline, jump controls
  • Slide outline + reorder controls with keyboard shortcuts
  • One-click Studio quality fixes (Fix This, Fix All) for common quality errors
  • Bundle artifacts (notes.md, talk-track.md) for presenter prep
  • Conservative offline visual pipeline (auto image selection + evidence-linked captions)
  • JSON schema 2.2 with media_catalog and per-slide visuals
  • Strict local runtime (no CDN, no cloud calls in generate/validate/studio)

Commands

  • hackluminary generate [PROJECT_DIR]
  • hackluminary validate [PROJECT_DIR]
  • hackluminary studio [PROJECT_DIR]
  • hackluminary doctor [PROJECT_DIR]
  • hackluminary init [PROJECT_DIR]
  • hackluminary presets
  • hackluminary sample [TARGET_DIR]
  • hackluminary models list
  • hackluminary models install <alias>
  • hackluminary images scan [PROJECT_DIR]
  • hackluminary images report [PROJECT_DIR] --json
  • hackluminary images benchmark CORPUS_DIR
  • hackluminary package devpost [PROJECT_DIR] --output PATH
  • hackluminary telemetry enable [PROJECT_DIR] --endpoint URL
  • hackluminary telemetry status [PROJECT_DIR]
  • hackluminary telemetry flush [PROJECT_DIR]
  • hackluminary telemetry disable [PROJECT_DIR]

Installation

Recommended

pipx install .

Development

python -m pip install -e '.[dev]'

Optional local AI dependencies

python -m pip install -e '.[ml]'

Release Build Dependencies

python -m pip install -e '.[release]'

Quick Start

Launch Studio

hackluminary studio . --base-branch main

Generate deck outputs

hackluminary generate . --preset demo-day --images auto --output deck --bundle

Validate quality gates only

hackluminary validate . --mode deterministic

generate options

  • --project-dir PATH
  • --output PATH
  • --format html|markdown|json|both
  • --preset quick|demo-day|investor
  • --slides title,problem,solution,demo,impact,tech,future,delta,closing
  • --max-slides N
  • --docs PATH (repeatable)
  • --theme default|dark|minimal|colorful|auto
  • --mode deterministic|ai|hybrid
  • --images off|auto|strict
  • --image-dirs PATH (repeatable, project-relative)
  • --max-images-per-slide 0..2
  • --visual-style evidence|screenshot|mixed
  • --base-branch NAME
  • --no-branch-context
  • --strict-quality / --no-strict-quality
  • --open
  • --copy-output-dir PATH
  • --bundle
  • --debug

Setup And Onboarding

hackluminary doctor .
hackluminary init .
hackluminary presets
hackluminary sample
  • doctor verifies local setup, project health, git context, model readiness, and Studio assets.
  • init writes hackluminary.toml using an interactive wizard.
  • sample creates a runnable demo project for first-time users.

Binary Distribution

Release workflow now builds and publishes:

  • standalone macOS binaries (macos-x64, macos-arm64)
  • standalone Windows binary (windows-x64)
  • standalone Linux binary (linux-x64)
  • wheel + source distribution
  • generated Homebrew formula + Winget manifests
  • checksum verification before publish
  • signing gate enforcement for macOS/Windows artifacts (override via ALLOW_UNSIGNED_RELEASE=1 secret)

GitHub release automation lives in:

  • .github/workflows/release.yml

Direct install scripts

macOS/Linux:

bash install/install.sh

Windows PowerShell:

powershell -ExecutionPolicy Bypass -File install/install.ps1

Optional environment overrides for installers:

  • HACKLUMINARY_REPO (default MindCore/HackLuminary)
  • HACKLUMINARY_VERSION (default latest)
  • HACKLUMINARY_INSTALL_DIR (custom install location)

studio options

  • --project-dir PATH
  • --base-branch NAME
  • --theme default|dark|minimal|colorful|auto
  • --port INT
  • --read-only
  • --debug

Configuration (hackluminary.toml)

Precedence:

  1. CLI flags
  2. Project config
  3. User config (~/.config/hackluminary/config.toml)
  4. Defaults

Sections:

  • [general]: mode, format, theme, max_slides, strict_quality
  • [git]: base_branch, include_branch_context
  • [ai]: enabled, backend, model_alias, max_tokens, top_p, temperature
  • [output]: copy_output_dir, open_after_generate
  • [images]: enabled, mode, image_dirs, max_images_per_slide, min_confidence, visual_style, max_image_bytes, allowed_extensions
  • [telemetry]: enabled, anonymous, endpoint (opt-in only; local event file by default)
  • [studio]: enabled, default_view, autosave_interval_sec, port, read_only
  • [ui]: density, motion, code_font_scale, presenter_timer_default_min
  • [features]: studio_enabled, production_theme_enabled, presenter_pro_enabled
  • [privacy]: telemetry=false

JSON schema 2.2

Top-level fields:

  • schema_version
  • metadata
  • git_context
  • slides
  • evidence
  • media_catalog
  • quality_report

Slide additions:

  • claims[]: { text, evidence_refs, confidence }
  • notes
  • visuals[]: { id, type, source_path, alt, caption, evidence_refs, confidence, width, height, sha256 }

Evidence additions:

  • source_path
  • source_kind
  • start_line
  • end_line
  • snippet
  • snippet_hash

Studio Session

Studio persists workspace state in:

  • .hackluminary/studio/session.json

Includes slide ordering, draft overrides, note blocks, pinned evidence, presenter state, and last validation. Automatic session snapshots are written to .hackluminary/studio/snapshots/ for crash recovery.

Pilot Rollout

Use /Users/pomoika/Documents/GitHub_repo/HackLuminary/PILOT_CHECKLIST.md for release and pilot-readiness gates.

Testing

python -m pytest

Browser Support

Studio and exported decks target current:

  • Chrome
  • Edge
  • Safari
  • Firefox

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hackluminary-2.2.0.tar.gz (100.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hackluminary-2.2.0-py3-none-any.whl (100.2 kB view details)

Uploaded Python 3

File details

Details for the file hackluminary-2.2.0.tar.gz.

File metadata

  • Download URL: hackluminary-2.2.0.tar.gz
  • Upload date:
  • Size: 100.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for hackluminary-2.2.0.tar.gz
Algorithm Hash digest
SHA256 2f6e33b925008eacbc4b71f1af12478a134ac07cc7204717d773231209d71c51
MD5 68760f78d5e2933b584d21a8bc6b7173
BLAKE2b-256 d1cc0cf8657e341b38e8e5458ff6419fc590b7106a2193db01944ba509c6dd3f

See more details on using hashes here.

File details

Details for the file hackluminary-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: hackluminary-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 100.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for hackluminary-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffb8f2e3bf41970505911fcb4fbf1ecc289d2322d11a9064c16112ecc9056959
MD5 5f562a274764e2f50b57604442491778
BLAKE2b-256 7de1074a83dc59132ad9fafa781b4bf36115a89db9ea48bea1d85272d385755e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page