Merge pull request #5 from meantrix/develop

0.0.4

Author: igor-siciliani

CHANGELOG.md

@@ -1,3 +1,31 @@
+## 0.0.4 (07/06/24)
+
+## Changelog for shutils Package - Version 0.0.4 (07/06/24)
+
+### New Methods in 0.0.4
+
+- **`gitlog`**: This function generates a comprehensive changelog between two specified branches, including detailed file changes. It's designed to provide insights into the modifications within a Git repository, listing all commits, the status of files (added, removed, modified), and producing a diff of the changes. This tool is particularly useful for developers and teams needing to track changes systematically before releases or for documentation purposes.
+
+  - **Usage**: `gitlog <base-branch> <head-branch> [ignore_ext1 ignore_ext2 ...]`
+  - **Features**:
+    - Fetches updates from the remote repository.
+    - Dynamically handles file paths and types with optional exclusions for certain file extensions.
+    - Outputs the results into a markdown file named with the current date and time, making it easy to incorporate into project documentation or version control systems.
+
+- **`gptsend`**: Automates the process of sending Markdown content to ChatGPT for processing, with the ability to customize the prompt and control the number of tokens returned. This method is useful for generating human-like text based on provided content, suitable for applications like automated changelog descriptions, summarizing documentation, or even generating content for reports.
+
+  - **Usage**: `gptsend <path-to-markdown-file> [prompt] [max_tokens] [model]`
+  - **Features**:
+    - Allows customization of the interaction by specifying the prompt, the model used for processing, and the maximum number of tokens.
+    - Utilizes OpenAI's API, requiring an API key set in the environment.
+    - Saves the generated response in a Markdown file timestamped to ensure traceability and version control.
+    - Incorporates error handling for file existence, API key availability, and necessary command dependencies.
+
+### Other Improvements and Fixes
+- Fixed the `instT` function to enhance compatibility with various Linux distributions, ensuring that Terraform installs smoothly without errors.
+- Streamlined error handling and user feedback mechanisms across the script suite to enhance usability and reliability.
+
+
 ## 0.0.3 (22/09/23)
 
 ### New Methods