dirprintly

dirprintly

dirprintly is a Python package that enhances directory and file exploration in the terminal by printing the contents of files in the current directory, and optionally, in all subdirectories. It provides a clear, color-coded display to improve readability and navigation.

Installation

Install dirprintly using pip:

pip install dirprintly

Usage

To print the contents of all files in the current directory:

dirprintly

To print the contents of all files in the current directory and all subdirectories, use:

dirprintly all

Features

• Simple Interface: A straightforward command-line interface.
• Color Coding: Uses color coding to distinguish between files and directories.

Requirements

• Python 3.6+
• colorama

Contributing

Contributions are welcome! Please read our Contributing Guide for more information about how to get involved.

License

dirprintly is released under the MIT License. See LICENSE for details.

---

Notes:

• Customize Further: Feel free to add or modify sections according to your package's needs. For example, if your package has a graphical interface, screenshots would be a great addition.
• Links: Replace placeholders like CONTRIBUTING.md and LICENSE with actual links to these files in your repository. If these documents do not exist, consider creating them or removing the links.
• Project Status: If your project is in an early stage, a beta release, or under active development, it might be helpful to include a status badge or a note about the project's stability.
• Examples and Documentation: For more complex packages, consider adding a link to the full documentation or including more comprehensive examples.

This template keeps the focus on what users most need to know, presenting it in an organized and easy-to-read format.