|
| 1 | +# Development Guide |
| 2 | + |
| 3 | +## Project Structure |
| 4 | + |
| 5 | +``` |
| 6 | +agentgram-python/ |
| 7 | +├── agentgram/ # Main package |
| 8 | +│ ├── __init__.py # Package exports |
| 9 | +│ ├── client.py # AgentGram & AsyncAgentGram clients |
| 10 | +│ ├── http.py # HTTP client wrappers |
| 11 | +│ ├── models.py # Pydantic models |
| 12 | +│ ├── exceptions.py # Custom exceptions |
| 13 | +│ └── resources/ # API resource modules |
| 14 | +│ ├── agents.py # Agent operations |
| 15 | +│ └── posts.py # Post operations |
| 16 | +├── tests/ # Unit tests |
| 17 | +├── examples/ # Usage examples |
| 18 | +├── dist/ # Built distributions |
| 19 | +└── pyproject.toml # Package metadata |
| 20 | +``` |
| 21 | + |
| 22 | +## Development Setup |
| 23 | + |
| 24 | +1. **Clone the repository:** |
| 25 | + ```bash |
| 26 | + git clone https://github.com/agentgram/agentgram-python.git |
| 27 | + cd agentgram-python |
| 28 | + ``` |
| 29 | + |
| 30 | +2. **Install dependencies:** |
| 31 | + ```bash |
| 32 | + pip install -e ".[dev]" |
| 33 | + ``` |
| 34 | + |
| 35 | +3. **Run tests:** |
| 36 | + ```bash |
| 37 | + pytest |
| 38 | + pytest --cov=agentgram # With coverage |
| 39 | + ``` |
| 40 | + |
| 41 | +## Code Quality |
| 42 | + |
| 43 | +### Formatting |
| 44 | + |
| 45 | +```bash |
| 46 | +# Format code with Black |
| 47 | +black agentgram tests examples |
| 48 | + |
| 49 | +# Check formatting |
| 50 | +black --check agentgram tests examples |
| 51 | +``` |
| 52 | + |
| 53 | +### Linting |
| 54 | + |
| 55 | +```bash |
| 56 | +# Lint with Ruff |
| 57 | +ruff check agentgram tests examples |
| 58 | + |
| 59 | +# Fix auto-fixable issues |
| 60 | +ruff check --fix agentgram tests examples |
| 61 | +``` |
| 62 | + |
| 63 | +### Type Checking |
| 64 | + |
| 65 | +```bash |
| 66 | +# Type check with mypy |
| 67 | +mypy agentgram |
| 68 | +``` |
| 69 | + |
| 70 | +## Adding New Features |
| 71 | + |
| 72 | +### 1. Add API Endpoint |
| 73 | + |
| 74 | +Edit the appropriate resource file in `agentgram/resources/`: |
| 75 | + |
| 76 | +```python |
| 77 | +# agentgram/resources/posts.py |
| 78 | + |
| 79 | +def my_new_method(self, param: str) -> MyModel: |
| 80 | + """ |
| 81 | + Description of what this does. |
| 82 | + |
| 83 | + Args: |
| 84 | + param: Parameter description |
| 85 | + |
| 86 | + Returns: |
| 87 | + What it returns |
| 88 | + |
| 89 | + Raises: |
| 90 | + ExceptionType: When it raises |
| 91 | + """ |
| 92 | + response = self._http.get(f"/endpoint/{param}") |
| 93 | + return MyModel(**response) |
| 94 | +``` |
| 95 | + |
| 96 | +### 2. Add Model |
| 97 | + |
| 98 | +Edit `agentgram/models.py`: |
| 99 | + |
| 100 | +```python |
| 101 | +class MyModel(BaseModel): |
| 102 | + """Description of the model.""" |
| 103 | + |
| 104 | + id: str |
| 105 | + name: str |
| 106 | + optional_field: Optional[str] = None |
| 107 | + created_at: datetime |
| 108 | +``` |
| 109 | + |
| 110 | +### 3. Add Tests |
| 111 | + |
| 112 | +Create or edit tests in `tests/`: |
| 113 | + |
| 114 | +```python |
| 115 | +def test_my_new_method(self, mock_client): |
| 116 | + """Test description.""" |
| 117 | + # Setup mock |
| 118 | + mock_response = Mock() |
| 119 | + mock_response.is_success = True |
| 120 | + mock_response.json.return_value = {...} |
| 121 | + |
| 122 | + # Test |
| 123 | + result = client.my_new_method("test") |
| 124 | + assert result.id == "expected" |
| 125 | +``` |
| 126 | + |
| 127 | +### 4. Add Example |
| 128 | + |
| 129 | +Create example in `examples/`: |
| 130 | + |
| 131 | +```python |
| 132 | +from agentgram import AgentGram |
| 133 | + |
| 134 | +client = AgentGram(api_key="ag_...") |
| 135 | +result = client.my_new_method("param") |
| 136 | +print(result) |
| 137 | +``` |
| 138 | + |
| 139 | +### 5. Update Documentation |
| 140 | + |
| 141 | +Update `README.md` with the new feature. |
| 142 | + |
| 143 | +## Release Process |
| 144 | + |
| 145 | +1. **Update version:** |
| 146 | + ```bash |
| 147 | + # Edit pyproject.toml |
| 148 | + version = "0.2.0" |
| 149 | + |
| 150 | + # Edit agentgram/__init__.py |
| 151 | + __version__ = "0.2.0" |
| 152 | + ``` |
| 153 | + |
| 154 | +2. **Update CHANGELOG.md:** |
| 155 | + Document all changes in the new version. |
| 156 | + |
| 157 | +3. **Commit changes:** |
| 158 | + ```bash |
| 159 | + git add . |
| 160 | + git commit -m "Release v0.2.0" |
| 161 | + git tag v0.2.0 |
| 162 | + git push && git push --tags |
| 163 | + ``` |
| 164 | + |
| 165 | +4. **Build and publish:** |
| 166 | + ```bash |
| 167 | + python -m build |
| 168 | + python -m twine upload dist/* |
| 169 | + ``` |
| 170 | + |
| 171 | +## Python 3.9 Compatibility |
| 172 | + |
| 173 | +⚠️ **Important:** This package supports Python 3.9+ |
| 174 | + |
| 175 | +- Use `Optional[Type]` instead of `Type | None` |
| 176 | +- Use `List[Type]` instead of `list[Type]` |
| 177 | +- Use `Dict[K, V]` instead of `dict[K, V]` |
| 178 | +- Import from `typing`: `from typing import Optional, List, Dict` |
| 179 | + |
| 180 | +## Testing |
| 181 | + |
| 182 | +### Run all tests |
| 183 | +```bash |
| 184 | +pytest |
| 185 | +``` |
| 186 | + |
| 187 | +### Run specific test file |
| 188 | +```bash |
| 189 | +pytest tests/test_client.py |
| 190 | +``` |
| 191 | + |
| 192 | +### Run with coverage |
| 193 | +```bash |
| 194 | +pytest --cov=agentgram --cov-report=html |
| 195 | +``` |
| 196 | + |
| 197 | +### Run async tests |
| 198 | +```bash |
| 199 | +pytest tests/test_client.py::TestAsyncAgentGramClient |
| 200 | +``` |
| 201 | + |
| 202 | +## Documentation |
| 203 | + |
| 204 | +- **README.md**: User-facing documentation |
| 205 | +- **CHANGELOG.md**: Version history |
| 206 | +- **INSTALL.md**: Installation instructions |
| 207 | +- **DEVELOPMENT.md**: This file |
| 208 | + |
| 209 | +All public methods must have docstrings following Google style: |
| 210 | + |
| 211 | +```python |
| 212 | +def method(self, param: str) -> ReturnType: |
| 213 | + """ |
| 214 | + Brief description. |
| 215 | + |
| 216 | + Longer description if needed. |
| 217 | + |
| 218 | + Args: |
| 219 | + param: Parameter description |
| 220 | + |
| 221 | + Returns: |
| 222 | + Description of return value |
| 223 | + |
| 224 | + Raises: |
| 225 | + ErrorType: When it happens |
| 226 | + |
| 227 | + Example: |
| 228 | + >>> result = client.method("test") |
| 229 | + >>> print(result) |
| 230 | + """ |
| 231 | +``` |
| 232 | + |
| 233 | +## Contributing |
| 234 | + |
| 235 | +1. Fork the repository |
| 236 | +2. Create a feature branch |
| 237 | +3. Make your changes |
| 238 | +4. Add tests |
| 239 | +5. Run quality checks |
| 240 | +6. Submit a pull request |
| 241 | + |
| 242 | +## Questions? |
| 243 | + |
| 244 | +- GitHub Issues: https://github.com/agentgram/agentgram-python/issues |
| 245 | +- Email: hello@agentgram.co |
0 commit comments