playtrak-sentinel 0.1.0

Sentinel: OSV-based vulnerability scanner for Python projects

Note
Sentinel is free and open-source. Contributions welcome!

---

📚 Table of Contents

• Introduction
• Key Features
• Getting Started
  • GitHub Action
  • GitLab CI
  • Command Line Interface
    • 1. Installation
    • 2. Running Your First Scan
  • Basic Commands
• CI Exit Codes
• License
• Supported Python Versions
• Resources
• Author

---

🔍 Introduction

Sentinel is a Python dependency vulnerability scanner powered by OSV.dev. It scans installed packages or requirements files for known security issues.

Sentinel is ideal for developers and teams who want to automate security checks in their local development and CI/CD pipelines.

---

✨ Key Features

• 🔍 Scan installed dependencies or requirements.txt
• 🚫 Detect known vulnerabilities via OSV.dev
• 🧾 Supports .trakignore to skip known issues
• 📄 Export reports to JSON and CSV
• 🚨 CI-ready: exits with 1 when vulnerabilities are found
• ⚡ Simple CLI, fast results

---

🚀 Getting Started

The job fails if any vulnerabilities are found.
Add a .trakignore file to suppress specific known issues.
You can also export scan results with --json and --csv for reporting.

✅ GitHub Action

Use Sentinel in CI pipelines easily with GitHub Actions:

name: Sentinel Scan

on:
  push:
    branches: [main]
  pull_request:

jobs:
  scan:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      - name: Install Sentinel
        run: pip install playtrak-sentinel

      - name: Run scan
        run: sentinel -r requirements.txt

---

✅ GitLab CI

You can integrate Sentinel in GitLab CI pipelines using the following example:

stages:
  - test

scan_vulnerabilities:
  image: python:3.10
  stage: test
  before_script:
    - pip install playtrak-sentinel
  script:
    - sentinel -r requirements.txt

---

🖥️ Command Line Interface

1. Installation

Install via pip:

pip install playtrak-sentinel

2. Running Your First Scan

Basic usage with default environment:

sentinel

Scan specific files:

sentinel -r requirements.txt
sentinel -r requirements.txt -r dev-requirements.txt

Export reports:

sentinel -r requirements.txt --json report.json --csv report.csv

Ignore specific vulnerabilities with .trakignore:

GHSA-xxxx-yyyy-zzzz
PYSEC-2023-0001

---

⚙️ Basic Commands

• sentinel: Scan installed environment
• sentinel -r file.txt: Scan specific requirements file
• --json: Export to JSON
• --csv: Export to CSV
• Uses .trakignore (optional) to skip vulnerabilities

---

🚦 CI Exit Codes

Code	Meaning
0	No vulnerabilities found
1	Vulnerabilities detected
2	Usage error (e.g., no files)

---

📜 License

MIT License

---

🐍 Supported Python Versions

Supports Python 3.7 and above. We recommend using the latest LTS version of Python for compatibility and security.

---

🤝 Contributing & Conduct

• Contributing Guidelines
• Code of Conduct

---

🔗 Resources

• OSV.dev vulnerability database
• PyPI: playtrak-sentinel
• GitLab Repository
• Website
• Documentation
• Issues & Feedback

👤 Author

Created by Eder Ramos for PLAYTRAK Sistemas de Monitoreo