docs: Python conventions

Author: mafrosis

python-conventions/CONVENTIONS.md

@@ -0,0 +1,24 @@
+When writing python code, you MUST follow these principles:
+
+- Provide clean, production-grade, high quality code
+- All code should target python version 3.9+ or greater
+- Use well-known python design patterns and object-oriented programming approaches
+- Quote strings and docstrings with single-quote not double-quote
+- Do not modify existing whitespace
+- Use only single quotes for strings, do not use speech marks
+- Provide code blocks with proper google style docstrings
+- Provide code blocks with input and return value type hinting
+- Always use type hints
+- Use F-string for formatting strings
+- Keep functions Small: Each function should do one thing and do it well
+- Use List and Dictionary Comprehensions: They are more readable and efficient
+- Use generators for large datasets to save memory
+- Use logging: Avoid print statements unless displaying information on CLI for the user
+- Never use f-strings in logging functions; use idiomatic string formatting
+- Implement robust error handling when calling external dependencies
+- CLI should use the Click library
+- All dependencies are defined in pyproject.toml and not in requirements.txt
+- Use PEP585 and PEP604 conventions for type hints
+- Always pass a pytz timezone to datetime.now()
+- Never change unrelated whitespace
+- Avoid catching Exception; catch only exceptions that are expected to be raised in the try block.

python-conventions/README.md

@@ -0,0 +1,30 @@
+# Python Coding Conventions
+
+This conventions file provides guidelines for writing clean, maintainable Python code. The conventions emphasize readability, consistency, and following Python best practices.
+
+## Purpose
+
+These conventions ensure that Python code is:
+- Readable and self-documenting
+- Consistent across projects
+- Following PEP 8 and other Python best practices
+- Easy to maintain and extend
+- Type-safe when using type hints
+
+## Use Cases
+
+This convention is intended for use when:
+- Writing new Python applications
+- Maintaining existing Python codebases
+- Developing Python libraries and packages
+- Writing scripts and automation tools
+- Using Python with frameworks like Django, Flask, or FastAPI
+
+## Usage
+
+[See How to Use These Conventions](https://github.com/Aider-AI/conventions#how-to-use-these-conventions)
+
+For Python-specific usage:
+1. Review the [CONVENTIONS.md](CONVENTIONS.md) file
+2. Configure your editor with Python linting tools
+3. Use type hints for better code safety