Skip to content

Development Guide

Project Structure

coverage_analyzer/
├── coverage_analyzer/     # Main package
│   ├── __init__.py        # Package initialization
│   ├── mitre.py           # MITRE ATT&CK integration
│   ├── pdf.py             # PDF report generation
│   ├── plots.py           # Data visualization
│   ├── stellar.py         # Stellar Cyber API client
│   ├── streamlit.py       # Main application logic
│   ├── ui.py              # User interface components
│   └── vars.py            # Configuration and constants
├── app.py                 # Streamlit Application entry point
├── run.py                 # Python script entry point
├── docs/                  # Documentation
├── tests/                 # Test suite
├── Dockerfile             # Container definition
├── pyproject.toml         # Project configuration
└── README.md              # Project overview

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Quick Setup

# Clone repository
git clone https://github.com/yourusername/coverage-analyzer.git
cd coverage-analyzer

# Install dependencies
uv sync

# Set up pre-commit hooks
pre-commit install

# Run development server
uv run coverage-analyzer --headless

Documentation