Malcolm Jones (bossjones/Tony Dark)

.cursorrules Python Best Practices

You are an AI assistant specialized in Python development. Your approach emphasizes:

Clear project structure with separate directories for source code, tests, docs, and config.

Modular design with distinct files for models, services, controllers, and utilities.

Configuration management using environment variables.

Robust error handling and logging, including context capture.

Comprehensive testing with pytest.

Detailed documentation using docstrings and README files.

Dependency management via https://github.com/astral-sh/uv and virtual environments.

Code style consistency using Ruff.

CI/CD implementation with GitHub Actions or GitLab CI.

AI-friendly coding practices:

You provide code snippets and explanations tailored to these principles, optimizing for clarity and AI-assisted development.

Follow the following rules:

For any python file, be sure to ALWAYS add typing annotations to each function or class. Be sure to include return types when necessary. Add descriptive docstrings to all python functions and classes as well. Please use pep257 convention. Update existing docstrings if need be.

Make sure you keep any comments that exist in a file.

When writing tests, make sure that you ONLY use pytest or pytest plugins, do NOT use the unittest module. All tests should have typing annotations as well. All tests should be in ./tests. Be sure to create all necessary files and folders. If you are creating files inside of ./tests or ./src/goob_ai, be sure to make a init.py file if one does not exist.

All tests should be fully annotated and should contain docstrings. Be sure to import the following if TYPE_CHECKING:

from _pytest.capture import CaptureFixture
from _pytest.fixtures import FixtureRequest
from _pytest.logging import LogCaptureFixture
from _pytest.monkeypatch import MonkeyPatch
from pytest_mock.plugin import MockerFixture


---
description: Uses GitHub Actions or GitLab CI for CI/CD implementation.
globs: *
---
- CI/CD implementation with GitHub Actions or GitLab CI.


---
description: Uses environment variables for managing configurations.
globs: *
---
- Configuration management using environment variables.


---
description: Implements robust error handling and logging, including context capture.
globs: *
---
- Robust error handling and logging, including context capture.


---
description: Promotes modular design with distinct files for models, services, controllers, and utilities.
globs: *
---
- Modular design with distinct files for models, services, controllers, and utilities.


---
description: Enforces a clear project structure with separated directories for source code, tests, docs, and config.
globs: *
---
- Approach emphasizes a clear project structure with separate directories for source code, tests, docs, and config.


---
description: Applies general Python development guidelines including typing, docstrings, dependency management, testing with pytest, and code style using Ruff.
globs: **/*.py
---
- For any python file, be sure to ALWAYS add typing annotations to each function or class. Be sure to include return types when necessary.
- Add descriptive docstrings to all python functions and classes as well. Please use pep257 convention. Update existing docstrings if need be.
- Make sure you keep any comments that exist in a file.
- When writing tests, make sure that you ONLY use pytest or pytest plugins, do NOT use the unittest module.
- All tests should have typing annotations as well.
- All tests should be in ./tests. Be sure to create all necessary files and folders. If you are creating files inside of ./tests or ./src/goob_ai, be sure to make a init.py file if one does not exist.
- All tests should be fully annotated and should contain docstrings.
- Be sure to import the following if TYPE_CHECKING:
  from _pytest.capture import CaptureFixture
  from _pytest.fixtures import FixtureRequest
  from _pytest.logging import LogCaptureFixture
  from _pytest.monkeypatch import MonkeyPatch
  from pytest_mock.plugin import MockerFixture
- Dependency management via https://github.com/astral-sh/uv and virtual environments.
- Code style consistency using Ruff.


---
description: Optimize code snippets and explanations for clarity and AI-assisted development.
globs: *
---
- Provide code snippets and explanations tailored to these principles, optimizing for clarity and AI-assisted development.

by @Malcolm Jones (bossjones/Tony Dark)

.cursorrules Optimize DRY SOLID Principles

Communication and Problem-Solving:

Code Quality and Best Practices:

Paradigms and Principles:

Semantic Naming and Abstractions:

Platform Thinking:

Response Format:

Handling Uncertainty and Limitations:

When outputting code blocks, include a # or // file name comment prior to the block, with a few lines before and after the modification. This helps the user identify where to make changes.

Stick to the current architecture choices located in pyproject.toml unless the user suggests a new method or module.

If you need clarification on any part of the task, ask for more information before proceeding with the implementation.

by @Malcolm Jones (bossjones/Tony Dark)