|
| 1 | +# python-devops AI Coding Instructions |
| 2 | + |
| 3 | +## Project Overview |
| 4 | +Python package for IBM Maximo DevOps utilities. Provides command-line tools for deployment automation, database validation, Slack notifications, and user management. Distributed as installable package with `setup.py`/`pyproject.toml` and standalone scripts in `bin/`. |
| 5 | + |
| 6 | +## Architecture |
| 7 | +- **bin/**: Executable CLI scripts (entry points) |
| 8 | + - `mas-devops-*`: Command-line tools for specific operations |
| 9 | + - Scripts import from `src/` package for implementation |
| 10 | + - Each script typically wraps a single operational task |
| 11 | +- **src/**: Main package source code |
| 12 | + - Organized by module/function (import path: `from mas_devops import ...`) |
| 13 | + - Core utilities: configuration management, API clients, database handlers |
| 14 | +- **test/**: Test suite (pytest structure) |
| 15 | + - Mirror `src/` structure in test files |
| 16 | + - Run with `pytest` or `make test` |
| 17 | +- **build/**: Generated artifacts (don't edit) |
| 18 | + - `*.egg-info/`: Package metadata |
| 19 | + - `dist/`, `*.whl`: Distribution packages |
| 20 | +- **setup.py** / **pyproject.toml**: Package definition |
| 21 | + - Entry points defined in setup.py pointing to `bin/` scripts |
| 22 | + - Dependencies in both files (must keep in sync) |
| 23 | + - Version defined once (check both files) |
| 24 | + |
| 25 | +## Key Patterns |
| 26 | +- **CLI Tool Pattern**: `bin/mas-devops-*` scripts are thin wrappers |
| 27 | + - Import main logic from `src/mas_devops/` |
| 28 | + - Handle argument parsing and error reporting |
| 29 | + - Example: `mas-devops-notify-slack` → calls slack notification module |
| 30 | +- **Dependency Management**: |
| 31 | + - Core dependencies in `setup.py` `install_requires` |
| 32 | + - Dev dependencies in `setup.py` `extras_require['dev']` |
| 33 | + - `requirements.txt` for pinned versions (reproducible installs) |
| 34 | + - Keep all three in sync |
| 35 | +- **Entry Points**: `setup.py` defines CLI commands |
| 36 | + - Format: `'mas-devops-task-name = mas_devops.module:main_function'` |
| 37 | + - Creates executable scripts in `bin/` when package installed |
| 38 | +- **Module Organization**: Import directly from package |
| 39 | + - `from mas_devops.db2_validator import validate_config` |
| 40 | + - Avoid deep nesting; keep public API clear |
| 41 | + |
| 42 | +## Development Workflow |
| 43 | +```bash |
| 44 | +make install # Install package in dev mode (pip install -e .) |
| 45 | +make test # Run pytest suite |
| 46 | +make test-verbose # Pytest with verbose output |
| 47 | +make build # Build distribution (wheel/tarball) |
| 48 | +make clean # Remove build artifacts |
| 49 | +make all # Clean, test, build |
| 50 | +``` |
| 51 | + |
| 52 | +## Important Conventions |
| 53 | +- **Python Version**: Check `setup.py` for `python_requires` (e.g., `>=3.8`) |
| 54 | +- **Entry Points**: Adding new CLI tool requires editing `setup.py` entry_points section |
| 55 | +- **Error Handling**: CLI scripts should catch exceptions and exit with meaningful error messages |
| 56 | +- **Logging**: Use Python logging module; configure in main module |
| 57 | +- **Testing**: Test structure mirrors source; test file for `src/module.py` is `test/test_module.py` |
| 58 | +- **Documentation**: Docstrings in functions should describe parameters, return, exceptions |
| 59 | +- **Imports**: Use absolute imports from package (`from mas_devops import ...`), not relative |
| 60 | + |
| 61 | +## Common CLI Tools (Reference) |
| 62 | +- `mas-devops-create-initial-users-for-saas`: User provisioning (SaaS) |
| 63 | +- `mas-devops-db2-validate-config`: Validate DB2 configuration |
| 64 | +- `mas-devops-notify-slack`: Send notifications |
| 65 | +- `mas-devops-saas-job-cleaner`: Cleanup SaaS jobs |
| 66 | + |
| 67 | +## Integration Points |
| 68 | +- **ansible-devops**: Playbooks call these Python utilities for infrastructure setup |
| 69 | +- **playbook**: Runbooks document procedures; Python tools automate them |
| 70 | +- **Standalone Usage**: Scripts can be called independently or from other tools via entry points |
| 71 | +- **Distribution**: Package installed via pip; entry points register CLI commands globally |
| 72 | + |
| 73 | +## When Adding New CLI Tool |
| 74 | +1. Create implementation module in `src/mas_devops/` |
| 75 | +2. Create script in `bin/mas-devops-tool-name` or update `setup.py` entry_points |
| 76 | +3. Add entry to `setup.py` entry_points section |
| 77 | +4. Add tests in `test/` matching module structure |
| 78 | +5. Update `requirements.txt` if adding dependencies |
| 79 | +6. Test with `make install` then run `mas-devops-tool-name --help` |
| 80 | + |
| 81 | +## Packaging & Distribution |
| 82 | +- Build: `python -m build` or `make build` |
| 83 | +- Outputs: wheel file in `dist/` ready for pip install |
| 84 | +- Version managed in `setup.py` (check both setup.py and pyproject.toml) |
0 commit comments