20251115_00-Update

- Docs and installer polish
- Bump to 1.1.2

Author: unixwzrd

CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog for UnicodeFix
 
-*Last updated: 2025-09-18*
+*Last updated: 2025-11-15*
+
+## 2025-11-15
+
+### Docs and installer polish (v1.1.2)
+
+- README: clarified installation modes (standard, editable, and NLP extras), tightened wording, and refreshed badges/links.
+- Setup: improved guidance printed by `setup.sh` after environment creation; clarified quick start steps.
+- Requirements: synced with current packaging to ensure local venv installs match `pyproject.toml` expectations.
+- No behavior changes to the cleaner; tests unchanged.
 
 ## 2025-09-18
 

README.md

@@ -1,12 +1,12 @@
-# UnicodeFix - *CodExorcism Edition+ v1.1.0*
+# UnicodeFix - *CodExorcism Edition+ v1.1.2*
 
 *Last updated: 2025-09-18*
 
 ![UnicodeFix Hero Image](docs/controlling-unicode.png)
 
 [![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](#) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) [![Release](https://img.shields.io/github/v/tag/unixwzrd/UnicodeFix?label=release)](https://github.com/unixwzrd/UnicodeFix/releases)
 
-- [UnicodeFix - *CodExorcism Edition+ v1.1.0*](#unicodefix---codexorcism-edition-v110)
+- [UnicodeFix - *CodExorcism Edition+ v1.1.2*](#unicodefix---codexorcism-edition-v112)
     - [**Finally - a tool that blasts AI fingerprints, torches those infuriating smart quotes, and leaves your code \& docs squeaky clean for real humans.**](#finally---a-tool-that-blasts-ai-fingerprints-torches-those-infuriating-smart-quotes-and-leaves-your-code--docs-squeaky-clean-for-real-humans)
   - [Why Is This Happening?](#why-is-this-happening)
   - [Installation](#installation)
@@ -21,10 +21,12 @@
     - [Audit only (no changes), human-readable](#audit-only-no-changes-human-readable)
     - [Audit as JSON](#audit-as-json)
     - [Audit with Semantic Metrics (experimental)](#audit-with-semantic-metrics-experimental)
+    - [Report without blocking commits](#report-without-blocking-commits)
     - [Fail CI if anomalies exceed threshold](#fail-ci-if-anomalies-exceed-threshold)
     - [Using in vi/vim/macvim](#using-in-vivimmacvim)
   - [What's New / What's Cool](#whats-new--whats-cool)
-    - [CodexExorcism Release (Sept 2025)](#codexexorcism-release-sept-2025)
+    - [CodexExorcism+ Release (Sept 2025)](#codexexorcism-release-sept-2025)
+    - [CodexExorcism Release (Sept 2025)](#codexexorcism-release-sept-2025-1)
     - [Previous Releases](#previous-releases)
     - [Keep It Fresh](#keep-it-fresh)
   - [Shortcut for macOS](#shortcut-for-macos)
@@ -67,10 +69,17 @@ Clone the repository and run the setup script:
 git clone https://github.com/unixwzrd/UnicodeFix.git
 cd UnicodeFix
 
+# This will create a VENV for python 3.10+ and install the dependencies
+./setup.sh
+
+# This will install teh UnicodeFix package, you can install one of three ways -"
+# For simply running the script, use the following command:
 pip install .
-# or for dev
+
+# If you wish to do development, or want to use the package in your own projects, use the following command:
 pip install -e .
-# optional extras for future NLP metrics:
+
+# if you wish to use teh optional NLTK analytics, install the following optional extras for current and future NLP metrics:
 pip install .[nlp]
 ```
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "unicodefix"
-version = "1.1.0"
+version = "1.1.2"
 description = "Clean Unicode quirks and audit text."
 readme = "README.md"
 requires-python = ">=3.9"

requirements.txt

@@ -1 +1,2 @@
-ftfy
+ftfy
+rich

setup.sh

@@ -3,11 +3,25 @@ $!/bin/bash
 python -m venv venv
 source venv/bin/activate
 pip install -r requirements.txt
-chmod +x bin/cleanup-text.py
 
 # Add the script to your PATH
 if [[ ! "$PATH" =~ "$PWD/bin" ]]; then
     echo "adding necessary items for Python script to run"
     echo "source $PWD/venv/bin/activate" >> ~/.bashrc
     echo "export PATH=\"$PWD/bin:\$PATH\"" >> ~/.bashrc
-fi
+fi
+
+# Source the .bashrc file to add the necessary items to the PATH
+source ~/.bashrc
+
+echo "You will need to install teh package using pip as described in the README.md file. Additional information is in the README.md file for more features of the package."
+echo ""
+echo "Quick Start - simply run the following command and it will install the package and make it available to use:"
+echo "pip install ."
+echo ""
+echo "If you wish to do development, or want to use the package in your own projects, use the following command:"
+echo "pip install -e ."
+echo ""
+echo "if you wish to use teh optional NLTK analytics, install the following optional extras for current and future NLP metrics:"
+echo "pip install .[nlp]"
+echo ""