rag-audit 0.1.0__tar.gz

rag_audit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,270 @@
+# =============================================================================
+# .github/workflows/ci.yml — Pipeline de Integração Contínua (CI)
+#
+# O que é GitHub Actions?
+# É o sistema de automação do GitHub. Você define "workflows" em arquivos YAML
+# dentro de .github/workflows/. Esses workflows rodam em servidores do GitHub
+# (chamados "runners") automaticamente quando certas coisas acontecem no repo.
+#
+# O que este workflow faz?
+# Toda vez que alguém abre um Pull Request ou faz push para main/develop,
+# este workflow roda automaticamente e verifica:
+#   1. Se o código está formatado corretamente (ruff)
+#   2. Se os tipos estão corretos (mypy)
+#   3. Se todos os testes passam (pytest) — em Python 3.11 e 3.12
+#   4. Se a cobertura de código está acima do mínimo
+#
+# Se qualquer passo falhar, o PR fica bloqueado (vermelho) até ser corrigido.
+# =============================================================================
+
+name: CI  # Nome que aparece na aba "Actions" do GitHub
+
+# ===========================================================================
+# `on` — Define QUANDO este workflow é disparado
+# ===========================================================================
+on:
+  push:
+    branches:
+      - main     # Roda quando há push direto para main
+      - develop  # Roda quando há push para develop
+
+  pull_request:
+    branches:
+      - main     # Roda em PRs que querem entrar em main
+      - develop  # Roda em PRs que querem entrar em develop
+
+  # Permite rodar o workflow manualmente pela UI do GitHub (botão "Run workflow")
+  workflow_dispatch:
+
+
+# ===========================================================================
+# `env` — Variáveis de ambiente disponíveis em TODOS os jobs
+# ===========================================================================
+env:
+  # Evita que o Python crie arquivos .pyc durante a CI (não precisamos deles)
+  PYTHONDONTWRITEBYTECODE: "1"
+
+  # Força o Python a não usar buffer no stdout/stderr (logs aparecem em tempo real)
+  PYTHONUNBUFFERED: "1"
+
+  # Versão padrão do uv (gerenciador de pacotes)
+  UV_VERSION: "latest"
+
+
+# ===========================================================================
+# `jobs` — Os trabalhos que vão rodar (cada job é independente)
+# ===========================================================================
+jobs:
+
+  # =========================================================================
+  # JOB 1: lint — Verifica formatação e estilo
+  #
+  # Roda ruff para checar se o código está formatado corretamente.
+  # É o job mais rápido (~10 segundos) e roda antes dos testes.
+  # Se o código estiver mal formatado, não faz sentido rodar os testes.
+  # =========================================================================
+  lint:
+    name: Lint & Format check
+    runs-on: ubuntu-latest  # Roda em uma VM Ubuntu gerenciada pelo GitHub (gratuito)
+
+    steps:
+      # Passo 1: Baixa o código do repositório para a VM
+      # `actions/checkout` é uma action oficial do GitHub
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Passo 2: Instala o Python
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      # Passo 3: Instala o uv (gerenciador de pacotes moderno e ultrarrápido)
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      # Passo 4: Instala as dependências de desenvolvimento (grupo [dev] do pyproject.toml)
+      - name: Install dev dependencies
+        run: uv sync --group dev
+
+      # Passo 5: Roda o ruff como linter (verifica problemas de código)
+      - name: Run ruff linter
+        run: uv run ruff check src/ tests/
+
+      # Passo 6: Roda o ruff como formatter (verifica se o código está formatado)
+      # --check não modifica arquivos, só verifica e retorna erro se precisar de formatação
+      - name: Run ruff format check
+        run: uv run ruff format --check src/ tests/
+
+
+  # =========================================================================
+  # JOB 2: typecheck — Verificação de tipos com mypy
+  #
+  # Analisa os type hints do código sem executá-lo.
+  # Roda em paralelo com o job de lint (jobs independentes rodam ao mesmo tempo).
+  # =========================================================================
+  typecheck:
+    name: Type check (mypy)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run mypy
+        run: uv run mypy src/rag_audit
+
+
+  # =========================================================================
+  # JOB 3: test — Roda a suíte de testes
+  #
+  # Este é o job mais importante. Usa uma "matrix strategy" para rodar
+  # os testes em múltiplas versões do Python ao mesmo tempo.
+  #
+  # Matrix strategy: em vez de criar um job por versão, você define uma matriz
+  # e o GitHub cria automaticamente um job para cada combinação.
+  # =========================================================================
+  test:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+
+    # Depende dos jobs de lint e typecheck — só roda se ambos passarem
+    needs: [lint, typecheck]
+
+    # Define a matriz de versões — cria um job para cada versão listada
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+      # fail-fast: false = se o teste falhar em 3.11, continua rodando em 3.12
+      # Útil para identificar se o problema é específico de uma versão
+      fail-fast: false
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Aqui usamos `matrix.python-version` para instalar a versão correta
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      # Cache das dependências do uv — evita baixar tudo do zero em cada run
+      # O cache é invalidado quando o pyproject.toml muda (hash do arquivo)
+      - name: Cache uv dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/uv
+          key: uv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ matrix.python-version }}-
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      # Roda os testes com cobertura de código
+      # --cov=src/rag_audit    = mede cobertura do código em src/rag_audit
+      # --cov-report=term-missing = mostra no terminal quais linhas não foram testadas
+      # --cov-report=xml       = gera coverage.xml (para upload no próximo passo)
+      # --cov-fail-under=80    = FALHA se a cobertura for menor que 80%
+      - name: Run tests with coverage
+        run: |
+          uv run pytest \
+            --cov=src/rag_audit \
+            --cov-report=term-missing \
+            --cov-report=xml \
+            --cov-fail-under=80 \
+            -m "not integration"
+
+      # Faz upload do relatório de cobertura para o Codecov
+      # Codecov é um serviço gratuito para OSS que mostra a cobertura em PRs
+      # (opcional — remova se não quiser usar)
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.11'  # Sobe apenas uma vez (evita duplicata)
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false  # Não falha a CI se o Codecov estiver fora do ar
+
+
+  # =========================================================================
+  # JOB 4: test-integration — Testes de integração (separados)
+  #
+  # Testes que chamam LLMs reais ou vector databases.
+  # Rodam SEPARADOS dos testes unitários porque:
+  #   1. São mais lentos
+  #   2. Precisam de API keys (secrets)
+  #   3. Custam dinheiro (chamadas à API da OpenAI/Anthropic)
+  #
+  # Só rodam em push para main (não em todo PR) para economizar recursos.
+  # =========================================================================
+  test-integration:
+    name: Integration tests
+    runs-on: ubuntu-latest
+    needs: [test]
+
+    # Condição: só roda em push para main, não em PRs
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run integration tests
+        # As API keys ficam em GitHub Secrets (Settings → Secrets → Actions)
+        # Nunca coloque chaves de API direto no código!
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+        run: |
+          uv run pytest -m "integration" --tb=short -v || ec=$?
+          [ "${ec:-0}" -eq 5 ] && exit 0 || exit "${ec:-0}"
+
+
+# ===========================================================================
+# RESUMO DO FLUXO EM UM PR:
+#
+#  Push / PR aberto
+#       │
+#       ├─── lint (ruff)      ──┐
+#       │                       ├── ambos passam → test (pytest matrix 3.11 + 3.12)
+#       └─── typecheck (mypy) ──┘                        │
+#                                                         └── testes passam → PR pode ser mergeado ✓
+#
+# Em push para main (após merge):
+#   └── test-integration (testes com LLMs reais)
+# ===========================================================================

rag_audit-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Install docs dependencies
+        run: uv sync --group docs
+
+      - name: Deploy docs
+        run: uv run mkdocs gh-deploy --force

rag_audit-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}

rag_audit-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml