BobAi/fss-polish
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
fss-polish/LINK.md
FSSCoding 9316bc50f1 Initial commit: FSS-Polish v1.0.0 
Complete implementation of Fast Spelling and Style Polish tool with:
- Australian English spelling conversion (7 patterns + case preservation)
- CLI support with text input or clipboard mode
- Daemon mode with configurable hotkey
- MIN_LENGTH, AGGRESSION, and CUSTOM_DICTIONARY config options
- Comprehensive diff logging
- 12 passing tests (100% test coverage for AU spelling)
- Wheel package built and ready for deployment
- Agent-friendly CLI with stdin/stdout support

Features:
- Text correction using t5-small-spoken-typo model
- Australian/American spelling conversion
- Configurable correction aggression levels
- Custom dictionary whitelist support
- Background daemon with hotkey trigger
- CLI tool for direct text polishing
- Preserves clipboard history (adds new item vs replace)

Ready for deployment to /opt and Gitea repository.
2025-10-25 23:59:34 +11:00

1.5 KiB
Raw Permalink Blame History

FSS Link Context

Project Overview

This project appears to be a Python-based text polishing tool, likely designed for clipboard manipulation and text processing. It includes functionality for hotkey handling, model loading, and utility functions.

Key Files and Directories

  • setup.py: Setup script for package installation
  • src/main.py: Main application logic
  • src/config.py: Configuration settings
  • src/hotkey.py: Hotkey handling functionality
  • src/model_loader.py: Model loading utilities
  • src/utils.py: Utility functions
  • test_main.py: Test file for main application
  • tests/test_polish.py: Test file for text polishing functionality
  • service/clipboard-polisher.service: System service configuration

Building and Running

  • The project uses Python with virtual environment setup (venv)
  • Main application logic is in src/main.py
  • Tests are run using pytest framework
  • The project likely requires installation via setup.py or pip install

Development Conventions

  • Code follows Python conventions
  • Uses virtual environment for dependency management
  • Testing uses pytest framework
  • Configuration files are in src/config.py
  • Main application logic is in src/main.py
  • Utility functions are in src/utils.py
  • Hotkey handling is in src/hotkey.py
  • Model loading is in src/model_loader.py

Usage

This directory contains a text polishing tool that handles clipboard manipulation and text processing. It's designed to be installed and run as a Python package with virtual environment support.