merger-cli 3.2.4__tar.gz → 3.2.6__tar.gz

{merger_cli-3.2.4/src/merger_cli.egg-info → merger_cli-3.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: merger-cli
-Version: 3.2.4
+Version: 3.2.6
 Summary: Merger is a tool that scans a directory, filters files using customizable patterns, and merges readable content into a single output file.
 Author-email: Diogo Toporcov <diogotoporcov@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -713,14 +713,18 @@ It supports **multiple output formats** (e.g., JSON, directory tree, plain text
 ## TLDR
 
 1.  **Install Python 3.8 or newer**
-2.  **Install libmagic** if not installed:
+2.  **Create and activate a virtual environment**: (If you want the CLI to be available globally, see [Global Installation](#global-installation))
+    *   **Windows**: `python -m venv .venv && .venv\Scripts\activate`
+    *   **Linux/macOS**: `python3 -m venv .venv && source .venv/bin/activate`
+3.  **Install libmagic** if not installed:
     *   **Windows**: Automatically downloaded
     *   **Linux**: `sudo apt-get update && sudo apt-get install libmagic1`  
     *   **macOS**: `brew install libmagic`
-3.  **Install the package**: `pip install merger-cli`
-4.  **Navigate to your project folder**: `cd path/to/your/project`
-5.  **Create a merger ignore file**: Manually or with `merger -c [TEMPLATE]` (Where the template is optional)
-6.  **Execute merger-cli**: `merger .` to create a single combined file called `merger.txt`
+4.  **Install the package**: `pip install merger-cli`
+5.  **Verify the installation**: `merger --version`
+6.  **Navigate to your project folder**: `cd path/to/your/project`
+7.  **Create a merger ignore file**: Manually or with `merger -c [TEMPLATE]` (See [Custom Ignore Templates](#custom-ignore-templates))
+8.  **Execute merger-cli**: `merger .` to create a single combined file called `merger.txt`
 
 For more options, refer to the [Usage](#usage) section below.
 
@@ -766,9 +770,52 @@ All Python package requirements are listed in [`requirements.txt`](requirements.
 
 ## Installation
 
-```bash
-pip install merger-cli
-```
+### Virtual Environment (Recommended)
+
+1. Create a virtual environment:
+    ```bash
+    python3 -m venv .venv
+    ```
+
+2. Activate the virtual environment:
+   * **Windows**: `.venv\Scripts\activate`
+   * **Linux/macOS**: `source .venv/bin/activate`
+
+3. Install the package:
+    ```bash
+    pip install merger-cli
+    ```
+
+4. Verify the installation:
+    ```bash
+    merger --version
+    ```
+
+### Global Installation
+
+If you want the CLI to be available globally, it is recommended to use **pipx**:
+
+1. **Install pipx** (if you don't have it):
+   * **Windows**: `python -m pip install --user pipx`
+   * **Linux**: `sudo apt update && sudo apt install pipx`
+   * **macOS**: `brew install pipx`
+
+2. **Install merger-cli**:
+   ```bash
+   pipx install merger-cli
+   ```
+
+3. **Ensure path**:
+   ```bash
+   pipx ensurepath
+   ```
+
+4. **Restart your terminal**.
+
+5. **Verify the installation**:
+   ```bash
+   merger --version
+   ```
 
 ---
 

{merger_cli-3.2.4 → merger_cli-3.2.6}/README.md

@@ -12,14 +12,18 @@ It supports **multiple output formats** (e.g., JSON, directory tree, plain text
 ## TLDR
 
 1.  **Install Python 3.8 or newer**
-2.  **Install libmagic** if not installed:
+2.  **Create and activate a virtual environment**: (If you want the CLI to be available globally, see [Global Installation](#global-installation))
+    *   **Windows**: `python -m venv .venv && .venv\Scripts\activate`
+    *   **Linux/macOS**: `python3 -m venv .venv && source .venv/bin/activate`
+3.  **Install libmagic** if not installed:
     *   **Windows**: Automatically downloaded
     *   **Linux**: `sudo apt-get update && sudo apt-get install libmagic1`  
     *   **macOS**: `brew install libmagic`
-3.  **Install the package**: `pip install merger-cli`
-4.  **Navigate to your project folder**: `cd path/to/your/project`
-5.  **Create a merger ignore file**: Manually or with `merger -c [TEMPLATE]` (Where the template is optional)
-6.  **Execute merger-cli**: `merger .` to create a single combined file called `merger.txt`
+4.  **Install the package**: `pip install merger-cli`
+5.  **Verify the installation**: `merger --version`
+6.  **Navigate to your project folder**: `cd path/to/your/project`
+7.  **Create a merger ignore file**: Manually or with `merger -c [TEMPLATE]` (See [Custom Ignore Templates](#custom-ignore-templates))
+8.  **Execute merger-cli**: `merger .` to create a single combined file called `merger.txt`
 
 For more options, refer to the [Usage](#usage) section below.
 
@@ -65,9 +69,52 @@ All Python package requirements are listed in [`requirements.txt`](requirements.
 
 ## Installation
 
-```bash
-pip install merger-cli
-```
+### Virtual Environment (Recommended)
+
+1. Create a virtual environment:
+    ```bash
+    python3 -m venv .venv
+    ```
+
+2. Activate the virtual environment:
+   * **Windows**: `.venv\Scripts\activate`
+   * **Linux/macOS**: `source .venv/bin/activate`
+
+3. Install the package:
+    ```bash
+    pip install merger-cli
+    ```
+
+4. Verify the installation:
+    ```bash
+    merger --version
+    ```
+
+### Global Installation
+
+If you want the CLI to be available globally, it is recommended to use **pipx**:
+
+1. **Install pipx** (if you don't have it):
+   * **Windows**: `python -m pip install --user pipx`
+   * **Linux**: `sudo apt update && sudo apt install pipx`
+   * **macOS**: `brew install pipx`
+
+2. **Install merger-cli**:
+   ```bash
+   pipx install merger-cli
+   ```
+
+3. **Ensure path**:
+   ```bash
+   pipx ensurepath
+   ```
+
+4. **Restart your terminal**.
+
+5. **Verify the installation**:
+   ```bash
+   merger --version
+   ```
 
 ---
 

{merger_cli-3.2.4 → merger_cli-3.2.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "merger-cli"
-version = "3.2.4"
+version = "3.2.6"
 description = "Merger is a tool that scans a directory, filters files using customizable patterns, and merges readable content into a single output file."
 keywords = ["merger", "file system", "concatenation", "automation", "development"]
 authors = [
@@ -52,3 +52,4 @@ build-backend = "setuptools.build_meta"
 
 [project.scripts]
 merger = "merger.cli:main"
+merger-cli = "merger.cli:main"

{merger_cli-3.2.4 → merger_cli-3.2.6}/src/merger/cli.py

@@ -92,6 +92,7 @@ class RichArgumentParser(argparse.ArgumentParser):
 
 def main() -> None:
     parser = RichArgumentParser(
+        prog="merger",
         description="Merge files from a directory into a structured output."
     )
 

{merger_cli-3.2.4 → merger_cli-3.2.6/src/merger_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: merger-cli
-Version: 3.2.4
+Version: 3.2.6
 Summary: Merger is a tool that scans a directory, filters files using customizable patterns, and merges readable content into a single output file.
 Author-email: Diogo Toporcov <diogotoporcov@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -713,14 +713,18 @@ It supports **multiple output formats** (e.g., JSON, directory tree, plain text
 ## TLDR
 
 1.  **Install Python 3.8 or newer**
-2.  **Install libmagic** if not installed:
+2.  **Create and activate a virtual environment**: (If you want the CLI to be available globally, see [Global Installation](#global-installation))
+    *   **Windows**: `python -m venv .venv && .venv\Scripts\activate`
+    *   **Linux/macOS**: `python3 -m venv .venv && source .venv/bin/activate`
+3.  **Install libmagic** if not installed:
     *   **Windows**: Automatically downloaded
     *   **Linux**: `sudo apt-get update && sudo apt-get install libmagic1`  
     *   **macOS**: `brew install libmagic`
-3.  **Install the package**: `pip install merger-cli`
-4.  **Navigate to your project folder**: `cd path/to/your/project`
-5.  **Create a merger ignore file**: Manually or with `merger -c [TEMPLATE]` (Where the template is optional)
-6.  **Execute merger-cli**: `merger .` to create a single combined file called `merger.txt`
+4.  **Install the package**: `pip install merger-cli`
+5.  **Verify the installation**: `merger --version`
+6.  **Navigate to your project folder**: `cd path/to/your/project`
+7.  **Create a merger ignore file**: Manually or with `merger -c [TEMPLATE]` (See [Custom Ignore Templates](#custom-ignore-templates))
+8.  **Execute merger-cli**: `merger .` to create a single combined file called `merger.txt`
 
 For more options, refer to the [Usage](#usage) section below.
 
@@ -766,9 +770,52 @@ All Python package requirements are listed in [`requirements.txt`](requirements.
 
 ## Installation
 
-```bash
-pip install merger-cli
-```
+### Virtual Environment (Recommended)
+
+1. Create a virtual environment:
+    ```bash
+    python3 -m venv .venv
+    ```
+
+2. Activate the virtual environment:
+   * **Windows**: `.venv\Scripts\activate`
+   * **Linux/macOS**: `source .venv/bin/activate`
+
+3. Install the package:
+    ```bash
+    pip install merger-cli
+    ```
+
+4. Verify the installation:
+    ```bash
+    merger --version
+    ```
+
+### Global Installation
+
+If you want the CLI to be available globally, it is recommended to use **pipx**:
+
+1. **Install pipx** (if you don't have it):
+   * **Windows**: `python -m pip install --user pipx`
+   * **Linux**: `sudo apt update && sudo apt install pipx`
+   * **macOS**: `brew install pipx`
+
+2. **Install merger-cli**:
+   ```bash
+   pipx install merger-cli
+   ```
+
+3. **Ensure path**:
+   ```bash
+   pipx ensurepath
+   ```
+
+4. **Restart your terminal**.
+
+5. **Verify the installation**:
+   ```bash
+   merger --version
+   ```
 
 ---
 

{merger_cli-3.2.4 → merger_cli-3.2.6}/src/merger_cli.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 merger = merger.cli:main
+merger-cli = merger.cli:main