git/tustu

mirror of https://github.com/johndoe6345789/tustu.git synced 2026-04-24 13:45:00 +00:00

Files

johndoe6345789 89317fbc21 Refactor documentation and consolidate scripts

- Deleted `IMPLEMENTATION_SUMMARY.md` as its content is now integrated into other documentation.
- Added `INDEX.md` for quick navigation of the scripts folder.
- Created `MARKDOWN_STYLE.md` to establish a consistent markdown style guide for documentation.
- Updated `README.md` to reflect the new documentation structure and provide links to additional resources.
- Introduced `README_SCRIPTS.md` detailing the consolidation of scripts into `tustu_tools.py`.
- Added `REORGANIZATION_SUMMARY.md` to summarize the changes made during the scripts reorganization.
- Removed `TEST_DATA_GENERATOR_FEATURE.md` as its content is now covered in `README_SCRIPTS.md`.
- Updated `scripts/README.md` to include links to new documentation files and improve clarity.

2026-01-11 21:09:51 +00:00

2.2 KiB

Raw Permalink Blame History

Scripts Folder

Clean, organized tool collection for the TuStu project.

Quick Start: ./tustu-tools gen-key --test-data (from project root)
Full Docs: TUSTU_TOOLS_README.md

📁 Structure

scripts/
├── tustu_tools.py           ⭐ Main unified tool
├── TUSTU_TOOLS_README.md    📖 Complete documentation
├── README_SCRIPTS.md        📋 Overview (detailed)
├── data/                    💾 Analysis & mapping data
└── legacy/                  📦 Original individual scripts

🚀 Quick Start

# From project root
./tustu-tools gen-key --test-data
./tustu-tools test-data -n 5

# From scripts folder
python3 tustu_tools.py gen-key --test-data
python3 tustu_tools.py --help

📚 Documentation

TUSTU_TOOLS_README.md - Complete usage guide with examples
legacy/README.md - Info about original scripts
data/README.md - JSON data files documentation
docs/ - Additional documentation (migration guide, style guide, etc.)

🛠️ Main Tool

File: tustu_tools.py (executable)

Unified command-line interface providing:

Registration key generation - All algorithms (4/5/7/8 param)
Test data creation - Realistic dummy data with valid keys
Java constructor fixing - Automated code repairs
Project structure analysis - Package and file organization
GUI launcher - PyQt6 registration interface

Run ./tustu-tools --help for full command list.

📦 Subfolders

Folder	Contents	Purpose
legacy/	8 original Python scripts	Preserved for reference; use `tustu_tools.py` instead
data/	4 JSON analysis files	Generated mapping/analysis data (not version controlled)

💡 Examples

# Generate 10 test registration keys
./tustu-tools test-data -n 10 --email-format > keys.txt

# Fix Java constructors in app directory
./tustu-tools fix-constructors -d ./app

# Analyze project structure
./tustu-tools analyze -o structure.json

# Launch GUI
./tustu-tools gui

For more examples, see TUSTU_TOOLS_README.md

2.2 KiB Raw Permalink Blame History