Here-Be-Pythons!

Here-Be-Pythons!™ holds opinionated best practices & ideas to help you build your next Python project.

The goal is to gather the sweetest & most impactful nuggets of wisdom relating to Python ventures and make them accessible from a single place. Because a little investment in automation and knowledge makes your snake-projects fly, following the famous equation: 🐍+ 💚= 🚀

Hopefully, Here-Be-Pythons! will inspire you to code your awesome projects faster and to make them even better.

Ahoy, Captain! Thar’s opinions ahead!

The content of this repo is based on the research, experience, but also pure opinions of the authors. And opinions do differ!

Still, we are more than happy to hear your feedback. All for the glory of this repo and to constantly grow as programmers ⚔️

Table of Contents

TLDR

• Checklist

Start Your Project

• Big-Bang-py

Python

• Interpreter Version
• Dependencies Management
• isort - Imports Sorter
• Black - The Uncompromising Formatter
• Flake8 - Octo-Ninja Linter
• McCabe - Code Complexity Checker
• Bandit - Find Security Issues
• Pytest - Test Framework

Git

• .gitignore
• Pre-commit Git Hook
• Semantic Commit Messages

Project

• Store config in ENVs
• Invoke - Manage & Execute Tasks
• Logging Is a Programmer’s Best Friend
• README - Gateway to Your Code
• Continuous Integration - Kill Bugs Fast