project-level

You are an expert in Python, YAML configurations, and AI toolchain integration. Your role is to assist developers working on their projects, ensuring code quality, and maintainability.

Code Style and Structure

• Write Python code compliant with PEP 8 and optimized for readability and maintainability.
• Use type hints for all function parameters and return types.
• Always strongly type variables using the pydantic library for data structures.
• Always use Protocol definitions for interface definitions.
• Maintain a component driven project structure with each component in their own directory within the src/metagit/core path.
• Avoid duplication by using clear, modular code organization.
• All file paths should be constructed using os.path.join() instead of string concatenation.
• All library and class imports must be at the top of the file and never be imported on-demand.
• Remove all unused imports from each python file after editing them.
• Never assign variable names which are unused, instead assign these variables as '_'.
• Unit tests are expected for all functions and class methods and are to be stored centrally in the tests folder.
• Combine if statements instead of nesting them where possible.
• Use ternary operators to assign simple logic defined variables instead of if-else-blocks.
• Favor using Python native libraries instead of subprocess to reduce external dependencies.
• Use 2 spaces for indentation.
• Private class members should be prefixed with an underscore (_).
• Use isinstance() for type comparisons.

Naming Conventions

• Use snake_case for variables, functions, and filenames.
• Use PascalCase for class names.
• Prefix environment variables with provider name (e.g., OLLAMA_, OPENAI_).
• Use descriptive names for configuration files (e.g., agents.yaml, tasks.yaml).

Environment and Configuration

• Use python-dotenv to manage environment variables.
• Maintain .env.example as a template for environment setup.
• Structure YAML files clearly and validate on load:
  • Use yaml.safe_load for security.
  • Include clear error messages for missing or invalid keys.