Update README.md to enhance documentation with quickstart examples and clarify usage instructions

Author: DefinetlyNotAI

ExceptionHandler/README.md

@@ -17,105 +17,83 @@ providing a consistent way to manage exceptions across your codebase.
 - **Script Exit Control**: Control whether the script exits after handling an exception.
 - **Return or Print Messages**: Choose to return exception messages as strings or print them directly.
 
+## Quickstart
+
+```python
+from ExceptionHandler import Handler, Colors, Format
+
+# Initialize a handler with helpful defaults
+handler = Handler(show_line=True, trace=True, use_timestamp=True)
+handler.formatter(main_color=Colors.RED, message_color=Colors.YELLOW, datetime_format="%d-%m-%Y %H:%M:%S")
+
+try:
+    1 / 0
+except Exception as e:
+    handler.exception(msg=e, exit_script=False)
+```
+
 ## Installation
 
 Clone the repository and ensure you have Python installed.
-Recommended to use Python 3.11 or higher.
+Recommended to use Python 3.9 or higher.
 
 ```bash
-git clone https://github.com/DefinetlyNotAI/ExceptionHandler.git
-cd ExceptionHandler
+git clone <repo-url>
+cd PyUtils
+pip install -r requirements.txt
 ```
 
 ## Usage
 
 ### Initialize the Handler
 
 ```python
-from exception import Handler, Colors, Format
+from ExceptionHandler import Handler
+handler = Handler()
+```
 
-# Initialize the Handler with custom settings - These are global settings
-# NOTE: return_string_rather_than_print has priority over exit_script both locally and globally!
-handler = Handler(
-    show_line=True,  # Show the line number where the exception occurred
-    trace=True,  # Include the traceback in the output
-    use_timestamp=True,  # Add a timestamp to the exception message
-    exit_script=True,  # Exit the script after handling the exception
-    return_string_rather_than_print=True
-    # Return the message instead of printing it,
-    # if True it will override/ignore exit_script
-)
+### Customize formatter
 
-# Customize the formatter
-# NOTE: Specific settings always the defaults,
-#       example if message_color is set it will override the main_color for the message part,
-handler.formatter(
-    main_color=Colors.RED,  # Set the main color to red
-    message_color=Colors.YELLOW,  # Set the message color to yellow
-    trace_color=Colors.CYAN,  # Set the traceback color to cyan
-    timestamps_color=Colors.GREEN,  # Set the timestamp color to green
-    main_format=Format.BOLD,  # Set the main format to bold
-    message_format=Format.UNDERLINE,  # Underline the message text
-    trace_format=Format.DIM,  # Dim the traceback text
-    timestamps_format=Format.BLINK,  # Blink the timestamp text
-    datetime_format="%d-%m-%Y %H:%M:%S"  # Customize the datetime format
+```python
+from ExceptionHandler import Colors, Format, Handler
+handler = Handler(
+  show_line=True,  # Show the line number where the exception occurred
+  trace=True,  # Include the traceback in the output
+  use_timestamp=True,  # Add a timestamp to the exception message
+  exit_script=True,  # Exit the script after handling the exception
+  return_string_rather_than_print=True
+  # Return the message instead of printing it,
+  # if True it will override/ignore exit_script
 )
+handler.formatter(main_color=Colors.RED, message_color=Colors.YELLOW)
 ```
 
 ### Example Function
 
 ```python
-# Bare Minimum
-from exception import Handler
-
-handler = Handler()  # Use default settings
-
-def divide_numbers(a, b):
-    try:
-        return a / b
-    except Exception as e:
-        # Note: You can just use handler.exception() or handler.exception(msg=e) to rely on global settings
-        handler.exception(
-            # These are local settings, if they are different from the global, they take priority
-            # so they will override the global settings only for this case.
-            msg=e,  # Detailed exception message, can be a custom string
-            exit_script=True,  # Exit the script after handling the exception
-            quit_code=1,  # Exit code to use when exiting the script, defaults to 1
-            return_string_rather_than_print=False  # Return the message instead of printing it
-            # NOTE: If return_string_rather_than_print is set to True globally,
-            #       and you want to locally quit for this singular case,
-            #       then you HAVE TO explicitly set it to False here.
-        )
-
-divide_numbers(10, 0)
+# Use the example script at example/ExceptionHandle.py for a full demonstration
 ```
 
-## Customization
-
-- **Global Settings**: Set during `Handler` initialization.
-- **Local Settings**: Override global settings in the `exception` method.
-- **Formatter**: Customize colors and formats using the `formatter` method.
-
-Check the [`example.py`](example.py) file for a proper example.
-
-### Override priority
+## Override priority
 
 - Local settings take precedence over global settings.
-  - If both global and local settings are provided, the local settings will override the global ones.
-  - To use the global settings, simply call `handler.exception()`/`handler.exception(msg=e)`.
-    - Any settings you want to override for this specific use case can be passed as arguments.
 - `return_string_rather_than_print` has priority over `exit_script` both locally and globally.
-  - If `return_string_rather_than_print` is set to `True` globally, and you want to locally quit for this singular case, then you HAVE TO explicitly set it to `False` in the local settings.
-
-### Modify Colors, Format or Messages
 
-If you want to modify the DataType for format's or colors ANSI, you can do so by modifying the `Format` and `Colors` classes in the [`exception.py`](colors.py) file.
+## Modify Colors, Format or Messages
 
-If you want to add/remove Messages from the dictionary, you can do so by modifying the `Messages` class in the [`messages.py`](messages.py) file.
+- Colors and formats are defined in `ExceptionHandler/colors.py`.
+- Generic messages are stored in `ExceptionHandler/messages.py`.
 
 ## Dependencies
 
-- Datetime
+- Datetime (standard library)
+- `TerminalPrint` for the default print function
+
+## Notes and Safety
+
+- If `exit_script` is True the program will call `sys.exit()` after printing/returning the message.
+- `return_string_rather_than_print` has priority over `exit_script` (if message is returned, the handler will not exit).
+- The default printing function is `TPrint().critical` from `TerminalPrint`. You can pass any callable that accepts a single string argument.
 
 ## License
 

README.md

@@ -0,0 +1,62 @@
+# PyUtils
+
+Lightweight collection of small Python utilities used across projects: a configurable exception handler, a colored terminal printing helper, and a simple Git update manager.
+
+Last updated: 2026-01-17
+
+## Modules
+
+- `ExceptionHandler/` — Friendly, configurable exception formatting and handling. See `ExceptionHandler/README.md` for details and examples.
+- `TerminalPrint/` — Console printing helper with color schemes, log-to-file and timestamp support. See `TerminalPrint/README.md`.
+- `UpdateManager/` — Small helper to fetch and merge updates from a remote Git branch for a local repo path. See `UpdateManager/README.md`.
+
+## Quickstart
+
+Install requirements (if any):
+
+```bash
+pip install -r requirements.txt
+```
+
+A short example using the three modules together:
+
+```python
+from TerminalPrint import TPrint
+from ExceptionHandler import Handler
+from UpdateManager import GitUpdateManager
+
+# Create a terminal printer
+printer = TPrint(debug_mode=True, use_timestamps=True)
+
+# Create an exception handler that uses the TPrint critical function
+handler = Handler(show_line=True, trace=True, use_timestamp=True, print_function=printer.critical)
+handler.formatter(main_color=printer.color_scheme['error'])
+
+# Attempt an update with handling
+try:
+    manager = GitUpdateManager(repo_path="../UpdateManager/", branch="main")
+    manager.update()
+except Exception:
+    handler.exception(exit_script=False)
+```
+
+## Examples
+
+Example scripts live under `example/`:
+- `example/TPrint.py` — demo for `TerminalPrint`.
+- `example/ExceptionHandle.py` — demo for `ExceptionHandler`.
+- `example/Update.py` — demo for `UpdateManager`.
+
+## Notes & Safety
+
+- `UpdateManager` calls the system `git` CLI and will `sys.exit()` on failures or when uncommitted changes are detected — ensure you have a clean working tree before running `update()`.
+- `ExceptionHandler` may call `sys.exit()` when `exit_script` is enabled; prefer `return_string_rather_than_print` for library usage.
+- Terminal coloring uses ANSI escape codes; results may vary on non-ANSI terminals (Windows terminals recent versions and WSL work well).
+
+## Contributing
+
+Contributions welcome — open a pull request and include tests/examples where appropriate.
+
+## License
+
+See the `LICENSE` file in the repository root.