Metadata-Version: 2.1
Name: dirmapper
Version: 1.0.0
Summary: A CLI tool to generate a directory structure mapping.
Home-page: https://github.com/nashdean/dirmap
Author: Nash Dean
Author-email: nashdean.github@gmail.com
License: UNKNOWN
Description: # Dirmap
        
        **Dirmap** is a CLI tool to generate a directory structure mapping. It provides a visual representation of the directory and file structure, similar to the `tree` command, with support for `.gitignore`-like patterns to exclude specific files and directories.
        
        ## Features
        
        - Generate a hierarchical view of a directory structure.
        - Support for `.mapping-ignore` file to exclude files and directories.
        - Optional integration with `.gitignore` to exclude patterns specified in `.gitignore`.
        
        ## Installation
        
        ### Using pipx
        
        It is recommended to use `pipx` to install `dirmap` in an isolated environment:
        
        ```sh
        pipx install dirmap
        ```
        
        ### Using pip
        
        You can also install `dirmap` using pip:
        
        ```sh
        pip install dirmap
        ```
        
        ## Usage
        
        ### Basic Usage
        
        To generate a directory structure mapping:
        
        ```sh
        dirmap /path/to/root_directory /path/to/output_file
        ```
        
        ### Exclude Patterns with .mapping-ignore
        
        Create a `.mapping-ignore` file in the root directory and specify the patterns you want to exclude:
        
        ```
        .git/
        *.tmp
        *.log
        ```
        
        Then run:
        
        ```sh
        dirmap /path/to/root_directory /path/to/output_file --ignore_file /path/to/.mapping-ignore
        ```
        
        ### Disable .gitignore Integration
        
        By default, `dirmap` will also consider patterns in `.gitignore`. To disable this feature:
        
        ```sh
        dirmap /path/to/root_directory /path/to/output_file --ignore_file /path/to/.mapping-ignore --no_gitignore
        ```
        
        ## Example
        
        ### Sample Directory Structure
        
        ```
        project/
        ├── .git/
        │   └── config
        ├── .github/
        │   └── workflows/
        │       └── ci.yml
        ├── src/
        │   ├── main.py
        │   ├── utils.py
        └── README.md
        ```
        
        ### Sample .mapping-ignore
        
        ```
        .git/
        .github/
        ```
        
        ### Command
        
        ```sh
        dirmap project output.txt --ignore_file project/.mapping-ignore
        ```
        
        ### Sample Output
        
        ```
        project/
        ├── src/
        │   ├── main.py
        │   └── utils.py
        └── README.md
        ```
        
        ## Development
        
        ### Running Tests
        
        Tests are written using `pytest`. To run the tests:
        
        1. Install the development dependencies:
        
        ```sh
        pip install -e .[dev]
        ```
        
        2. Run the tests:
        
        ```sh
        pytest
        ```
        
        ## Contributing
        
        Contributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.
        
        ## License
        
        This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
        
        ## Author
        
        **Nash Dean**
        - [GitHub](https://github.com/nashdean)
        - [Email](mailto:nashdean.github@gmail.com)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Provides-Extra: dev
