Skip to content

Installation

System Requirements

  • Python: 3.10 or higher
  • Operating System: macOS, Linux, or Windows with WSL
  • Memory: Minimum 512MB RAM
  • Disk Space: ~100MB

Installation Methods

# Clone repository
git clone https://github.com/kiranreddi/sentinel-ci.git
cd sentinel-ci

# Create virtual environment (optional but recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

For contributors who want to modify the code:

# Clone repository
git clone https://github.com/kiranreddi/sentinel-ci.git
cd sentinel-ci

# Install in editable mode with dev dependencies
pip install -e .
pip install -r requirements-dev.txt

docker pull kiranreddi/sentinel-ci:latest
docker run -e CI_PLATFORM=jenkins \
           -e JENKINS_URL=https://jenkins.example.com \
           -e JENKINS_TOKEN=user:token \
           kiranreddi/sentinel-ci:latest

Verify Installation

Test that everything is installed correctly:

# Run tests
pytest tests/ -v

# Run demo
PYTHONPATH=. python examples/demo.py

Expected output: 

✓ 17 tests passed
✓ Demo displays ASCII art and mock data

Dependencies

Core Dependencies

fastmcp>=0.2.0      # MCP server framework
requests>=2.31.0    # HTTP client
pydantic>=2.0.0     # Data validation

Development Dependencies

pytest>=7.0.0       # Testing framework
pytest-cov>=4.0.0   # Coverage reporting
ruff>=0.1.0         # Linting
mypy>=1.0.0         # Type checking

Platform-Specific Setup

macOS

# Install Python 3.11 via Homebrew
brew install python@3.11

# Clone and install
git clone https://github.com/kiranreddi/sentinel-ci.git
cd sentinel-ci
pip3.11 install -r requirements.txt

Linux (Ubuntu/Debian)

# Install Python 3.11
sudo apt update
sudo apt install python3.11 python3.11-venv python3-pip

# Clone and install
git clone https://github.com/kiranreddi/sentinel-ci.git
cd sentinel-ci
pip3 install -r requirements.txt

Windows (WSL)

# Install WSL first if not already installed
wsl --install

# In WSL terminal:
sudo apt update
sudo apt install python3.11 python3-pip git

# Clone and install
git clone https://github.com/kiranreddi/sentinel-ci.git
cd sentinel-ci
pip3 install -r requirements.txt

IDE Setup

VS Code

  1. Install Python extension
  2. Open sentinel-ci folder
  3. Select Python interpreter (Ctrl+Shift+P → "Python: Select Interpreter")
  4. Install recommended extensions:
  5. Python
  6. Pylance
  7. Ruff

PyCharm

  1. Open sentinel-ci as project
  2. Configure Python interpreter (Settings → Project → Python Interpreter)
  3. Mark sentinel_ci/ as Sources Root
  4. Enable pytest as test runner

Troubleshooting

pip: command not found

Install pip: 

# macOS
python3 -m ensurepip --upgrade

# Linux
sudo apt install python3-pip

Permission denied

Use virtual environment instead of system Python: 

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

SSL certificate errors

Update certificates: 

# macOS
/Applications/Python\ 3.11/Install\ Certificates.command

# Linux
sudo apt install ca-certificates

Next Steps