v1.3.0 - Badge Generation Feature

v1.3.0 — Badge Generation Feature

Added

Badge Generation System

• Dynamic badge generation for your manuscript statistics
• Badge types:
  • Word Count (emerald green)
  • Achievement (milestone, vibrant blue)
  • Chapters (purple/lavender)
  • Reading Pages (amber/gold)
• Multiple output formats:
  • SVG (lightweight, ~1.5 KB) — ideal for READMEs
  • PNG (2–4 KB) — raster for direct embedding
• CLI support:
  • --badges (comma-separated list)
  • --badge-formats (svg,png)
  • --badge-dir (custom output directory)
• Interactive mode support:
  • Multi-select badge types and formats via checkbox UI
• Files saved as: ./musestat/badges/{manuscript}_{badge_type}.{format}

Technical

• New musestat/io/badges.py module (SVG rendering, optional PNG via cairosvg)
• CLI wiring in musestat/cli/commands.py (args + interactive flow)
• Optional dependency: cairosvg for PNG conversion
• Professional visual design: gradients, shadow, rounded corners, improved typography

---

Release date: 2025-11-01
Tag: v1.3.0

v1.2.1 - Critical Bug Fix: Update Notifications

Bug Fix Release

This release fixes a critical bug where version update notifications were never displayed to users.

Fixed

• Version Update Notifications: The version check infrastructure existed but was never called in the CLI
  • Now displays beautiful panel notification when updates are available
  • Non-blocking, silent check with 24-hour caching
  • Shows current version, latest version, and download link

Changed

• Updated all documentation references from v1.2.0 to v1.2.1
• Enhanced SECURITY.md with improved disclosure policy and version history section
• Improved cross-references between documentation files in CONTRIBUTING.md

What's New

Users will now be notified when new versions are available! The notification appears as a beautiful panel at the start of MuseStat, displaying:

• New version available message
• Current and latest version numbers
• Direct download link to GitHub releases

Installation

Download the appropriate executable for your platform or install from source:

# From source
git clone https://github.com/Tfc538/MuseStat.git
cd MuseStat
pip install -r requirements.txt
python main.py

Full Changelog

See CHANGELOG.md for complete version history.

---

Full Changelog: v1.2.0...v1.2.1

Version 1.2.0 - Display Customization & Visual Enhancements

What's New in v1.2.0

Display Customization CLI Options

Version 1.2.0 introduces 8 new CLI options for complete control over your manuscript analysis display:

• --top-words N - Specify number of frequent words to display (default: 15)
• --max-chapters N - Limit chapters shown in detail view
• --min-word-length N - Set minimum word length for frequency analysis (default: 1)
• --sparkline-width N - Customize sparkline chart width (default: 40)
• --hide-word-frequency - Hide word frequency table
• --hide-heat-map - Hide density heat map visualization
• --hide-chapter-details - Hide chapter breakdown table
• --show-top-chapters N - Show top N longest chapters summary

Visual Enhancements

Transform your manuscript analysis with beautiful unicode visualizations:

• Sparkline Charts () - Chapter length trends at a glance
• Color-Coded Indicators () - Traffic light system for readability scores
• Green = Easy/Good | Yellow = Fair/Moderate | Red = Difficult
• Trend Arrows () - See metric changes with directional arrows
• Heat Maps () - Visual density maps across chapters
• Balance Visualization - Chapter consistency indicators
• Mini-Bars - Visual progress bars in tables

Usage Examples

# Show 30 frequent words with 4+ letters
musestat manuscript.md --top-words 30 --min-word-length 4

# Limit display for large manuscripts
musestat manuscript.md --max-chapters 20 --show-top-chapters 10

# Clean, focused output
musestat manuscript.md --hide-word-frequency --hide-heat-map

# Wide sparklines for large terminals
musestat manuscript.md --sparkline-width 80

Technical Details

• New visualizations.py module with 15+ reusable visualization components
• Enhanced analyzer with customization parameters
• Updated table and panel functions with optional parameters
• Comprehensive documentation including new Visual Features Guide
• All changes backward compatible

Documentation

• Visual Features Guide
• Full Changelog
• Documentation Index

Statistics

• 16 files changed
• 1,385+ lines added
• 8 new CLI options
• 15+ new visualization functions

---

Full Changelog: v1.1.0...v1.2.0

MuseStat v1.1.0 - Arrow Key Navigation

MuseStat v1.1.0 - Enhanced Interactive Experience

Arrow key navigation is here!

What's New

Arrow Key Navigation

Navigate menus with your keyboard like a pro:

• Arrow Keys: Move up and down through options
• Enter: Select your choice
• Visual Highlighting: See exactly what you're selecting
• Custom Styling: Beautiful purple and green color scheme

Before vs After

v1.0.x: Type numbers to select
v1.1.0: Use arrow keys + visual selection

Professional Project Governance

MuseStat now has complete open-source governance:

• Code of Conduct (Contributor Covenant v2.0)
• Contributing Guidelines (dev setup, code style, testing)
• Security Policy (vulnerability reporting)
• Issue Templates (bug reports, feature requests, questions)
• PR Template (comprehensive testing checklist)

Updated Contact Information

• Author: Tim Gatzke
• Email: post@tim-gatzke.de
• Website: tim-gatzke.de

Download

Choose your platform (builds include optimized caching for faster CI/CD):

• Windows: musestat-windows-x64.exe
• Linux: musestat-linux-x64
• macOS: musestat-macos-x64

All Features Included

Interactive arrow key navigation
Welcome screen with feature overview
File discovery and selection
Analysis type menu
Word counts and chapter analysis
Readability metrics
Dialogue and pacing detection
Manuscript verification
Export to JSON, CSV, HTML
Multi-format support (MD, TXT, DOCX, RTF)

Upgrade from v1.0.x

Download the new executable - all previous features included plus enhanced navigation!

Happy Writing!

MuseStat v1.0.2 - Platform-Specific Executables

MuseStat v1.0.2 - Platform-Specific Executables + Performance

Bug Fixes

Fixed executable naming issue where Linux and macOS builds were overwriting each other.

Performance Improvements

Added caching to GitHub Actions workflow:

• Pip dependency caching: 40-60% faster dependency installation
• PyInstaller build caching: 20-30% faster subsequent builds
• Total improvement: Build times reduced from ~2 minutes to 30-60 seconds on cache hits

Downloads

All three platform-specific executables now correctly available:

• Windows: musestat-windows-x64.exe
• Linux: musestat-linux-x64
• macOS: musestat-macos-x64

What's Included

All features from v1.0.1:

• Interactive TUI mode when double-clicked
• Welcome screen and file selection menu
• Analysis type selection
• All core analysis features
• Advanced metrics (readability, dialogue, pacing)
• Verification system
• Export to JSON, CSV, HTML
• Multi-format support

Happy Writing!

MuseStat v1.0.1 - Interactive Mode

MuseStat v1.0.1 - Interactive TUI Mode

Improved executable user experience!

What's New in v1.0.1

Interactive Mode

When you double-click the executable (or run without arguments), MuseStat now launches an interactive menu instead of immediately closing:

• Welcome Screen: Beautiful introduction to MuseStat features
• File Discovery: Automatically finds all manuscript files in current directory
• File Selection Menu: Choose from numbered list of available files
• Analysis Type Menu: Select your preferred analysis mode:
  1. Quick Summary (compact view)
  2. Standard Analysis (recommended)
  3. Full Analysis (with chapters and word frequency)
  4. Advanced Analysis (readability, dialogue, pacing)
  5. Verify Manuscript (publishing readiness check)
• Stay Open: Window no longer closes immediately after analysis

Perfect For

• First-time users
• Non-technical writers
• Quick double-click analysis
• Anyone who prefers interactive menus over command-line arguments

CLI Still Available

Power users can still use all command-line options for scripting and automation.

Download

Choose your platform from the Assets below (building now):

• Windows: musestat-windows-x64.exe
• Linux: musestat-linux-x64
• macOS: musestat-macos-x64

Upgrade from v1.0.0

Simply download the new executable - all features from v1.0.0 are included plus the new interactive mode.

Happy Writing!

MuseStat v1.0.0 - Initial Public Release

MuseStat v1.0.0 - Initial Public Release

First public release of MuseStat!

MuseStat is a beautiful terminal-based manuscript statistics analyzer designed specifically for fiction writers.

Key Features

Core Analysis

• Word, character, sentence, and paragraph counting
• Smart chapter detection (multiple formats)
• Reading time estimation
• Page count estimation
• Achievement system with writing milestones
• Motivational quotes from famous authors

Advanced Features

• Language detection with language-specific stop words
• Readability metrics (Flesch-Kincaid, Gunning Fog, Coleman-Liau)
• Dialogue analysis and ratio calculation
• Pacing detection (long sentences/paragraphs)
• Progress tracking and comparison
• Scene break detection

Verification System

• 12 comprehensive check categories
• Markdown formatting validation
• Typo detection
• Punctuation checking
• Smart quotes consistency
• Pre-publish marker detection

Supported Formats

• Markdown (.md, .markdown)
• Plain Text (.txt)
• Word Documents (.docx)
• Rich Text Format (.rtf)

Export Options

• JSON, CSV, HTML

Installation

Download the pre-built executable for your platform from the Assets section below (building now).

Or install from source:

git clone https://github.com/Tfc538/MuseStat.git
cd MuseStat
pip install -r requirements.txt
python main.py --help

Documentation

See README.md and CHANGELOG.md for details.

Happy Writing!