Files
tustu/scripts/INDEX.md
johndoe6345789 db8eac5a02 feat: Add unified command-line utility for TunerStudio project
- Introduced `tustu_tools.py` to consolidate various scripts into a single command-line tool.
- Implemented key generation functionality with multiple algorithms.
- Added dummy data generation and email formatting capabilities.
- Included structure analysis and constructor fixing for Java files.
- Created wrapper script `tustu-tools` for easy access to the utility.
- Developed test scripts for dummy data and email generation.
- Added a script for reorganizing the app directory structure.
2026-01-11 21:05:10 +00:00

1.9 KiB

Scripts Folder - Quick Index

Quick navigation guide for the scripts folder.

🎯 What You Need

I want to... Go to...
Generate registration keys, test data, or use tools tustu_tools.py - Documentation
Understand the folder organization README_SCRIPTS.md
Access original scripts legacy/ folder - Details
View analysis data data/ folder - Details

📖 Documentation Files

File Purpose
README.md Quick overview and examples
README_SCRIPTS.md Detailed migration guide
TUSTU_TOOLS_README.md Complete tool documentation
INDEX.md This file (quick navigation)

🔧 Main Tool

File: tustu_tools.py

Quick Commands:

python3 tustu_tools.py --help        # Show all commands
python3 tustu_tools.py gen-key -t    # Generate key with test data
python3 tustu_tools.py test-data -n 5  # Generate 5 test sets
python3 tustu_tools.py gui           # Launch GUI

From project root:

./tustu-tools --help
./tustu-tools gen-key --test-data

📂 Folder Contents

Main Files (scripts/)

  • tustu_tools.py - Unified command-line tool
  • 📖 *.md - Documentation files

legacy/

  • All original individual Python scripts
  • Preserved for reference
  • See legacy/README.md

data/

  • JSON mapping and analysis files
  • Generated data files
  • See data/README.md

🚦 Getting Started

  1. First time? Start with README.md
  2. Need examples? Check TUSTU_TOOLS_README.md
  3. Migrating code? Read README_SCRIPTS.md