Ferret 🦡

Framework for Enhance: Organized Workflow Library Ferret is a Python tool designed specifically to create 'enhance.pet' compliant Python packages. This tool offers a user-friendly way to generate a package structure that follows the guidelines and best practices of the enhance.pet framework.

Features 🌟

• 'enhance.pet' Compliance: Designed to generate package structures that are fully compliant with the enhance.pet framework.
• Interactive CLI: Offers an interactive command-line interface.
• Customization: Allows package name, author, and location to be user-defined.
• Code Structure: Automatically generates necessary files and directories.
• Template Preambles: Adds Sphinx-compatible documentation templates to Python modules.

Installation 🛠️

To install Ferretz, run:

pip install ferretz

Usage 🚀

After installation, start Ferretz using the CLI:

ferretz

Follow the on-screen instructions to create your enhance.pet compliant Python package.

Directory Structure

Generated package structure will be fully compliant with enhance.pet guidelines:

your_package_namez/
├── your_package_namez/
│   ├── __init__.py
│   └── [other_modules].py
├── README.md
└── setup.py

Contributing 🤝

Contributions, issues, and feature requests are welcome!

License 📄

Licensed under the MIT License - see the LICENSE.md file for details.