1.1 KiB
1.1 KiB
AGENTS.md: Agent Guidelines
Build, Lint, Test
- Run entrypoint:
python main.py - No project-wide test/lint commands found; recommend:
- Run one test:
pytest test_file.py::test_func(if pytest added) - Lint:
flake8 .orpylint main.py(if installed) - Requirements: add
requirements.txtif using dependencies
- Run one test:
- No environment or shell scripts present.
Code Style
- Follow PEP8: 4 spaces per indent, <=79 chars/line
- Use explicit imports, not wildcard imports
- Place stdlib, 3rd party, and local imports in separate groups
- Use type annotations for all public functions/parameters
- Snake_case for functions/vars; PascalCase for classes; UPPER_SNAKE for constants
- Write docstrings for all public functions/classes
- Handle errors with try/except and log exception details
- One statement per line; no trailing whitespace
- Avoid global state; prefer function/class encapsulation
- Place entry code in
if __name__ == '__main__'block - No Cursor or Copilot rules/configs detected
Update this document if configs or standards are added later.