FERRET - Framework for Enhance: Organized Workflow Library
import os
import shutil
from pathlib import Path
from random import choice

# ANSI Escape Codes for color output
RED = '\033[91m'
GREEN = '\033[92m'
BLUE = '\033[38;5;141m'
RESET = '\033[0m'
TEMPLATE_EXTENSION = ".tmpl"


def greet_user():
    print('')
    intro = "🦡 Hi, I'm Ferret, your fabulously sassy package creator. 🎩✨"
    joke = "I'm here to declutter your code life—because research is messy but your code doesn’t have to be!"
    greeting = choice([
        "So, shall we code or what?",
        "Ready to make some structured magic?",
        "Shall we dive in, Darling?",
    ])
    print(f"{intro}\n{joke}\n{greeting}")
    print('')


def create_directory_structure(package_name, author, email, target_dir):
    print(f"{BLUE}🦡 Creating your lair... Ahem, I mean your package directory! 📦{RESET}")

    root = Path(target_dir) / package_name
    root.mkdir(parents=True, exist_ok=True)
    package_dir = root / package_name
    package_dir.mkdir(exist_ok=True)
    setup_py = root / 'setup.py'

    modules = [
        'constants.py', 'display.py', 'download.py', 'file_utilities.py',
        'image_conversion.py', 'image_processing.py', '__init__.py',
        'input_validation.py', f"{package_name}.py", 'resources.py'
    ]

    module_descriptions = {
        'constants.py': 'This module holds all the constant values.',
        'display.py': 'This module is responsible for displaying information.',
        'download.py': 'This module handles downloading of files.',
        'file_utilities.py': 'This module provides utilities for file operations.',
        'image_conversion.py': 'This module performs image conversions.',
        'image_processing.py': 'This module handles image processing tasks.',
        '__init__.py': 'Initialization module for the package.',
        'input_validation.py': 'This module validates user input.',
        f'{package_name}.py': f'This is the main module for {package_name}.',
        'resources.py': 'This module manages resources.'
    }

    summary = []

    ferretz_directory = os.path.dirname(os.path.abspath(__file__))
    template_modules_directory = os.path.join(ferretz_directory, "template_modules")
    existing_module_templates = [file for file in os.listdir(template_modules_directory) if file.endswith(TEMPLATE_EXTENSION)]
    summary.append(f"Existing modules: {existing_module_templates} at {template_modules_directory}")

    for module in modules:
        module_path = os.path.join(package_dir, module)

        # Checks if a template file exists
        if f"{module}{TEMPLATE_EXTENSION}" in existing_module_templates:
            shutil.copy(os.path.join(template_modules_directory, f"{module}{TEMPLATE_EXTENSION}"), module_path)
            summary.append(f"Copied: {module_path} (from template repository)")
        else:
            description = module_descriptions.get(module, 'No description available.')
            with open(module_path, 'w') as f:
                preamble = f"""#!/usr/bin/env python3
            
# -*- coding: utf-8 -*-

'''
.. module:: {module[:-3]}
   :platform: Unix, Windows
   :synopsis: {description}

.. moduleauthor:: {author} <{email}>

'''

# Your code here
"""
                f.write(preamble)
            summary.append(f"Created: {module_path}")

    with open(setup_py, 'w') as f:
        content = f"""from setuptools import setup, find_packages

setup(
    name='{package_name}',
    version='0.1',
    packages=find_packages(),
    author='{author}',
    author_email='{email}',
    url='',  # Add your package's homepage URL here
    description='',  # Add a short description of the package here
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    install_requires=[],  # List your package's dependencies here
    classifiers=[
        'Programming Language :: Python :: 3',
    ],
    python_requires='>=3.10',
)
"""
        f.write(content)
        summary.append(f"Created: {setup_py}")

    print(f"{GREEN}🦡 Your new den... er, package, is ready to rumble! 🎉{RESET}")
    return summary


def post_generation_summary(summary):
    print(f"{BLUE}🦡 Here's a sneak peek at what I've dug up for you: 🐾{RESET} ")
    for item in summary:
        print(f"  - {item}")
    print('')
    print(f"{BLUE}Next steps:{RESET} ")
    print("  1️⃣  Review the generated files.")
    print("  2️⃣  Populate the modules with your code.")
    print("  3️⃣  Install dependencies if necessary.")
    print("  4️⃣  Test your package.")
    print("  5️⃣  Create a README.md and other documentation.")
    print("  6️⃣  Run 'python setup.py sdist bdist_wheel' to package your project.")
    print("  7️⃣  Install twine if you haven't: 'pip install twine'")
    print("  8️⃣  Run 'twine upload dist/*' to upload your package to PyPI.")


def create_new_package():
    while True:
        package_name = input(f"{BLUE}🦡 What's the name of the new package? (Must end with 'z') 📦{RESET} ")
        if package_name.endswith('z'):
            break
        else:
            print(f"{RED}🦡 Oopsie! Your package name should end with a 'z'. Retry! 🚫{RESET} ")

    author = input(f"{BLUE}🦡 Who's the genius behind this package? (Author's name) 👩‍💻{RESET} ")
    email = input(f"{BLUE}🦡 Got an email, smarty-pants? 📧{RESET} ")

    while True:
        target_dir = input(f"{BLUE}🦡 Where should I dig the new hole... um, I mean, where should the package be created? (Provide the full path) 🗂{RESET} ")
        if Path(target_dir).exists():
            break
        else:
            print(f"{RED}🦡 Oops! That hole doesn't exist... I mean, directory! Try again. 🚫{RESET} ")

    summary = create_directory_structure(package_name, author, email, target_dir)
    print('')
    post_generation_summary(summary)


def main():
    greet_user()
    action = input(f"{BLUE}🦡 What's on the agenda today, boss? ('new' to create a new package, 'exit' to ...exit.) 🎬{RESET} ")

    if action.lower() == 'new':
        create_new_package()
    elif action.lower() == 'exit':
        print(f"{BLUE}🦡 Goodbye! 👋{RESET} ")
        return
    else:
        print(f"{RED}🦡 Aww, shucks! I don't know that command. 🚫{RESET} ")


if __name__ == "__main__":
    main()

ferretz/ferretz.py
QIMP-Team/FERRET
# setup.py for ferretz
from setuptools import setup, find_packages
setup(
    name='ferretz',
    version='0.3',
    description='A Python package to create "enhance.pet" compliant package folder structures',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Lalith Kumar Shiyam Sundar',
    author_email='lalith.shiyamsundar@meduniwien.ac.at',
    url='https://github.com/LalithShiyam/ferretz',  # Replace with your GitHub URL
    license='MIT',  # Replace with your license
    packages=find_packages(),
    package_data={'ferretz': ['template_modules/*.py.tmpl']},
    include_package_data=True,
    entry_points={
        'console_scripts': ['ferretz=ferretz.ferretz:main'],
    },
    classifiers=[
        'Development Status :: 3 - Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
    ],
    keywords='enhance.pet, package creation, Python',
    install_requires=[
        # List your package dependencies here
    ],
)

setup.py
QIMP-Team/FERRET