Python Project Template 🐍

Kickstart your Python projects with this powerful and opinionated template! 🎉 Designed with best practices in mind, it features automatic code formatting and static code analysis, helping you focus on writing great code while maintaining top-notch quality. 🚀

✨ Features

• PEP8-Compliant: Automatically enforces Python’s PEP8 coding standards.
• Code Formatter & Linter: Includes black for formatting and mypy for type checking.
• Hexagonal Architecture: Encourages clean, maintainable, and scalable code organization.
• SOLID Principles: Fosters strong software design practices.
• Utility Classes: Packed with helpful classes to speed up development.

🛠️ Technologies Used

This template leverages:

• Black – A fast, deterministic code formatter.
• Mypy – A static type checker for Python.

⚙️ Requirements

Before using this template, ensure you have the following installed:

• Python 3.10 or higher.

🚀 Installation

To get started with the template, follow these steps:

On Windows:

python -m venv venv
./venv/Scripts/activate
pip install -r requirements.txt

On Linux/macOS:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

🧑‍💻 Usage

Write your code directly within the template. When you're ready to format and lint, simply run:

python prettier.py

This will automatically format and check your code for you. Easy peasy! ✨

🤝 Contributing

Contributions are welcome! If you'd like to suggest improvements or report issues, feel free to open a pull request or an issue. 🙌

Before contributing, please ensure:

• Your code adheres to PEP8 standards.

📜 License

This project is licensed under the MIT License. You are free to use, modify, and distribute it as you see fit. 😊