Skip to content

Commit bcb4f7a

Browse files
jaykrishna316jaykrishna316
committed
feat: Add/update AGENTS.md for AI agent guidance
Generated by Braxis https://github.com/jaykrishna316/braxis Co-Authored-By: Jayakrishna Ichapurapu
1 parent d2956ff commit bcb4f7a

4 files changed

Lines changed: 513 additions & 0 deletions

File tree

‎.agentic-config.json‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
{
2+
"metadata": {
3+
"project_name": "replicate-python",
4+
"description": "A Python project with Python (setuptools)",
5+
"generated_by": "Braxis",
6+
"generated_at": "2026-10-09T18:38:49.160037",
7+
"schema_version": "1.0"
8+
},
9+
"project": {
10+
"languages": [
11+
"python"
12+
],
13+
"primary_language": "python",
14+
"build_system": "Python (setuptools)",
15+
"architecture": "single-package",
16+
"is_monorepo": false,
17+
"monorepo_type": null,
18+
"subsystems": []
19+
},
20+
"ai_readiness": {
21+
"overall_score": 68,
22+
"tier": "AI-Native",
23+
"dimensions": {
24+
"architecture": {
25+
"score": 0,
26+
"reason": "Code organization and modularity"
27+
},
28+
"testing": {
29+
"score": 15,
30+
"reason": "52 test files found"
31+
},
32+
"dependencies": {
33+
"score": 12,
34+
"reason": "Dependency management and version pinning"
35+
},
36+
"conventions": {
37+
"score": 8,
38+
"reason": "Consistency in naming and patterns"
39+
},
40+
"entry_points": {
41+
"score": 0,
42+
"reason": "0 critical files identified"
43+
},
44+
"security": {
45+
"score": 10,
46+
"reason": "Input validation and error handling"
47+
},
48+
"build": {
49+
"score": 10,
50+
"reason": "Build system clarity and configuration"
51+
},
52+
"documentation": {
53+
"score": 8,
54+
"reason": "README and code documentation"
55+
}
56+
}
57+
},
58+
"development": {
59+
"setup_command": "pip install -e . && uv sync --all-groups",
60+
"test_command": "pytest",
61+
"lint_command": "ruff check .",
62+
"format_command": "ruff format .",
63+
"dev_server_command": null,
64+
"prerequisites": {
65+
"language_version": "3.9+",
66+
"package_manager": "pip or uv",
67+
"key_tools": [
68+
"pytest",
69+
"ruff",
70+
"mypy"
71+
]
72+
}
73+
},
74+
"architecture": {
75+
"pattern": "single-package project",
76+
"main_entry": "Standard layout",
77+
"key_modules": [],
78+
"layers": [
79+
"CLI interface (if applicable)",
80+
"Business logic",
81+
"Utilities and helpers"
82+
]
83+
},
84+
"mcp_servers": [],
85+
"core_principles": [
86+
"Modularity - Code organized by functionality",
87+
"Testability - Comprehensive test coverage",
88+
"Clarity - Code easy for AI agents to understand",
89+
"Consistency - Uniform patterns throughout"
90+
],
91+
"contribution_criteria": {
92+
"what_we_want": [
93+
"Bug fixes with test coverage",
94+
"Code quality improvements",
95+
"Test coverage increases",
96+
"Documentation improvements",
97+
"Performance optimizations"
98+
],
99+
"what_we_dont_want": [
100+
"New dependencies without justification",
101+
"Code that reduces test coverage",
102+
"Inconsistent naming or style",
103+
"Dead code or commented code"
104+
]
105+
},
106+
"contribution_boundaries": {
107+
"project_scale": "small",
108+
"suggestion": "This small project can accept most contributions. Consider boundaries as it grows."
109+
},
110+
"commands": {
111+
"setup": {
112+
"command": "pip install -e . && uv sync --all-groups",
113+
"description": "Install dependencies and set up development environment"
114+
},
115+
"test": {
116+
"command": "pytest",
117+
"description": "Run all tests"
118+
},
119+
"lint": {
120+
"command": "ruff check .",
121+
"description": "Check code style and quality"
122+
},
123+
"format": {
124+
"command": "ruff format .",
125+
"description": "Format code to project standards"
126+
}
127+
},
128+
"testing": {
129+
"framework": "pytest",
130+
"total_tests": 52,
131+
"pass_rate": 100,
132+
"run_command": "pytest"
133+
}
134+
}

‎.cursorrules‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Cursor Rules for replicate-python
2+
3+
## What This Project Does
4+
5+
**Language:** Python | **Build:** Python (setuptools)
6+
7+
**AI Readiness Score:** 68/100 (AI-Native)
8+
9+
## Must-Follow Rules
10+
11+
### Code Style & Formatting
12+
13+
1. Use **ruff** for formatting: `ruff format .`
14+
2. Use **ruff** for linting: `ruff check .`
15+
3. Python conventions: **snake_case** for functions/variables, **PascalCase** for classes
16+
4. Type hints: Required for all public functions using **mypy** for checking
17+
5. Docstrings: Use triple-quoted strings for all public functions and classes
18+
6. No commented-out code, no dead code
19+
7. Max line length: 100 characters
20+
21+
### Testing
22+
1. Framework: pytest
23+
2. Test file naming: `test_*.py` or `*_test.py`
24+
3. Test discovery: `pytest` finds and runs all tests
25+
4. Fixtures: Use pytest fixtures for setup/teardown
26+
5. Coverage: Maintain 80%+ coverage for critical paths
27+
6. Run before commit: `pytest -v`
28+
29+
### Imports & Dependencies
30+
1. Use absolute imports, not relative imports (unless necessary)
31+
2. Group imports: stdlib, third-party, local (isort style)
32+
3. No wildcard imports (`from module import *`)
33+
4. Pin versions in requirements.txt/pyproject.toml
34+
5. Avoid circular dependencies
35+
36+
### Error Handling
37+
1. Be specific with exception types (not bare `except:`)
38+
2. Log errors before re-raising
39+
3. Validate all function arguments at entry points
40+
4. Use try/except at system boundaries (I/O, network, DB)
41+
42+
43+
## Scoring Dimensions (What Matters)
44+
45+
These 8 areas drive AI readiness. Focus on these when making changes:
46+
47+
1. **Architecture** (0/15) - Code organization and modularity
48+
2. **Testing** (15/15) - Test coverage and quality
49+
3. **Dependencies** (12/12) - Dependency management
50+
4. **Conventions** (8/10) - Consistent patterns
51+
5. **Entry Points** (0/10) - Clear main/start locations
52+
6. **Security** (10/15) - Input validation and error handling
53+
7. **Build** (10/10) - Clear build/setup instructions
54+
8. **Documentation** (8/8) - Code and project documentation
55+
56+
## Before You Commit
57+
58+
```bash
59+
# Format code
60+
ruff format .
61+
62+
# Lint check
63+
ruff check .
64+
65+
# Run tests
66+
pytest
67+
```
68+
69+
All checks must pass before committing.
70+
71+
## Questions?
72+
73+
See AGENTS.md for detailed documentation on architecture, development workflow, and testing strategy.
74+
75+
---
76+
77+
*Generated by Braxis - language-aware rules for Python projects*

0 commit comments

Comments
 (0)