github-pages-auditor 1.2.0__py3-none-any.whl

github_pages_auditor-1.2.0.dist-info/METADATA

@@ -0,0 +1,520 @@
+Metadata-Version: 2.4
+Name: github-pages-auditor
+Version: 1.2.0
+Summary: Audit every public repo of a GitHub user in one command: Pages health, releases and quality checks. JSON/Markdown output and CI exit codes. Works with or without a token.
+Keywords: github,github-pages,auditor,cli,ci,json,repository-health,portfolio
+Author: Alberto Ortiz
+Author-email: Alberto Ortiz <albertoortixsanchez@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Utilities
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=15.0.0
+Maintainer: Alberto Ortiz
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/alberto2005-coder/github-pages-auditor
+Project-URL: Repository, https://github.com/alberto2005-coder/github-pages-auditor
+Project-URL: Issues, https://github.com/alberto2005-coder/github-pages-auditor/issues
+Project-URL: Author, https://github.com/alberto2005-coder/
+Project-URL: Website, https://albertoortiz.is-a.dev/
+Description-Content-Type: text/markdown
+
+# GitHub Profile & Pages Auditor
+
+[Español](#español) | [English](#english)
+
+> Desarrollado por / Developed by **[Alberto Ortiz](https://github.com/alberto2005-coder/)** · 🌐 [albertoortiz.is-a.dev](https://albertoortiz.is-a.dev/)
+
+---
+
+<a name="español"></a>
+# Español
+
+Herramienta de línea de comandos en Python para auditar los repositorios públicos de un usuario de GitHub: mapea los enlaces de **GitHub Pages** (incluido un dominio personalizado), detecta **releases** y evalúa la calidad del repositorio (README, licencia, `.gitignore` y descripción).
+
+Se controla **solo con parámetros de consola**: no necesita archivo `.env`. El **token de la API es opcional**: con token usa la API oficial de GitHub; sin token usa un modo web público de "mejor esfuerzo".
+
+## Índice
+
+1. [Características](#características-es)
+2. [Modos de funcionamiento: con y sin API](#modos-es)
+3. [Requisitos previos](#requisitos-previos-es)
+4. [Instalación](#instalación-es)
+5. [Uso por línea de comandos](#uso-es)
+6. [Jerarquía de configuración](#configuración-es)
+7. [Códigos de salida](#salida-es)
+8. [Formatos de salida e integración en CI](#formatos-es)
+9. [Pruebas automatizadas](#pruebas-es)
+10. [Estructura del proyecto](#estructura-es)
+11. [Seguridad](#seguridad-es)
+12. [Autor](#autor-es)
+13. [Licencia](#licencia-es)
+
+---
+
+<a name="características-es"></a>
+## Características
+
+- **Mapeo de GitHub Pages:** raíz (`<usuario>.github.io`) o subruta por repositorio, verificando que la URL responde de verdad.
+- **Releases:** detectadas mediante el feed Atom público, sin consumir cuota de la API.
+- **Auditoría de calidad:** sin README, sin licencia, sin `.gitignore` y sin descripción (About).
+- **Clasificación:** forks y repositorios archivados.
+- **Rendimiento:** todo el análisis se hace en paralelo (`ThreadPoolExecutor`) con reintentos y timeout.
+- **Informe determinista:** los repositorios salen siempre en el mismo orden; un fallo de red en un repo no tumba el resto (se lista aparte).
+- **Créditos del autor** en `--help`, `--version`, la consola y el informe.
+
+<a name="modos-es"></a>
+## Modos de funcionamiento: con y sin API
+
+| | Con token (`-k` / `GITHUB_TOKEN`) | Sin token |
+| :--- | :--- | :--- |
+| Fuente de datos | API REST oficial (5.000 peticiones/hora) | Páginas públicas de GitHub (HTML, `raw`, Atom) |
+| Fiabilidad | **Alta** | De mejor esfuerzo: depende del marcado público de GitHub |
+| Límite | 5.000/h | Puede recibir `429` si se abusa |
+| Se activa | Automáticamente si hay token | Si no hay token, o con `--no-api` |
+
+El token **solo se envía a `api.github.com`**.
+
+**URL de las Pages:** con API se usa la URL real que GitHub tiene configurada (incluido tu dominio personalizado). Sin API, si no indicas `-w`, se prueba `https://<usuario>.github.io/...` y, si GitHub redirige a tu dominio personalizado, se detecta y se muestra ese dominio. Con `-w` se comprueba directamente ese dominio.
+
+<a name="requisitos-previos-es"></a>
+## Requisitos previos
+
+- **Python** 3.10 o superior.
+- **Gestor de paquetes:** [`uv`](https://docs.astral.sh/uv/) (recomendado) o `pip`.
+
+<a name="instalación-es"></a>
+## Instalación
+
+- **Sin instalar nada (recomendado), con [`uv`](https://docs.astral.sh/uv/):**
+  ```bash
+  uvx github-pages-auditor -u tu_usuario
+  ```
+- **Instalarlo como comando:** `uv tool install github-pages-auditor` o `pip install github-pages-auditor`.
+
+El comando antiguo `ver-github-pages` sigue funcionando como alias.
+
+Para desarrollar desde el código fuente:
+
+```bash
+git clone https://github.com/alberto2005-coder/github-pages-auditor.git
+cd github-pages-auditor
+```
+
+- **Con `uv` (recomendado):**
+  ```bash
+  uv sync
+  ```
+- **Con `pip`:**
+  ```bash
+  pip install -e .
+  ```
+
+<a name="uso-es"></a>
+## Uso por línea de comandos
+
+```text
+github-pages-auditor -u USUARIO [-w DOMINIO] [-k TOKEN] [-o ARCHIVO] [opciones]
+```
+
+**Ejemplos**
+
+```bash
+# 1. Básico, sin token ni .env (modo web)
+uv run github-pages-auditor -u alberto2005-coder
+
+# 2. Con dominio personalizado y token (modo API)
+uv run github-pages-auditor -u alberto2005-coder -w https://albertoortiz.is-a.dev -k ghp_tu_token
+
+# 3. Forzar modo web aunque haya token y cambiar el archivo de salida
+uv run github-pages-auditor -u alberto2005-coder -k ghp_tu_token --no-api -o mi_reporte.txt
+
+# 4. Token por variable de entorno (más seguro: no queda en el historial del shell)
+GITHUB_TOKEN=ghp_tu_token uv run github-pages-auditor -u alberto2005-coder
+
+# 5. También funciona como módulo
+python -m github_pages_auditor -u alberto2005-coder
+```
+
+**Opciones**
+
+| Parámetro | Alternativas | Descripción | Obligatorio |
+| :--- | :--- | :--- | :--- |
+| `-u` | `--usuario`, `--user` | Usuario de GitHub | **Sí** (o `USUARIO_GITHUB`) |
+| `-w` | `--web`, `--dominio` | Dominio base de las Pages | No (def. `https://<usuario>.github.io`) |
+| `-k` | `--key`, `--token` | Personal Access Token (activa la API) | No |
+| `-o` | `--output` | Archivo del informe; `-` = salida estándar | No (def. `paginas_github.<formato>`) |
+| `-f` | `--format` | `txt`, `json` o `md` | No (def. `txt`) |
+| `--fail-on` | | Reglas que provocan código de salida 1 (o `any`) | No |
+| `--exclude-forks` | | Ignora los forks | No |
+| `--exclude-archived` | | Ignora los repositorios archivados | No |
+| `--inject` | | Actualiza la tabla de demos dentro de un archivo (README) | No |
+| `-q` | `--quiet` | Sin tablas ni progreso | No |
+| `--workers` | | Hilos en paralelo | No (def. `15`) |
+| `--timeout` | | Timeout por petición, en segundos | No (def. `10`) |
+| `--no-api` | | Fuerza el modo web aunque haya token | No |
+| `--no-color` | | Consola sin colores | No |
+| `--no-env` | | No leer el archivo `.env` | No |
+| `-V` | `--version` | Versión y créditos | No |
+| `-h` | `--help` | Ayuda y créditos | No |
+
+<a name="configuración-es"></a>
+## Jerarquía de configuración
+
+1. **Parámetros de consola** (`-u`, `-w`, `-k`, `-o`…).
+2. **Variables de entorno**, incluidas las de un archivo `.env` **opcional** en el directorio actual: `USUARIO_GITHUB`, `DOMINIO_WEB`, `GITHUB_TOKEN`, `ARCHIVO_SALIDA`. Un valor vacío se trata como no definido.
+3. **Valores por defecto.**
+
+Hay una plantilla en [`.env.example`](https://github.com/alberto2005-coder/github-pages-auditor/blob/master/.env.example).
+
+<a name="salida-es"></a>
+## Códigos de salida
+
+| Código | Significado |
+| :---: | :--- |
+| `0` | Auditoría correcta e informe escrito |
+| `1` | Una regla de `--fail-on` encontró hallazgos (el informe sí se escribe) |
+| `2` | Error: parámetros inválidos, usuario inexistente, token rechazado, límite de tasa, red o escritura |
+| `3` | No hay repositorios que analizar (no se escribe informe) |
+| `130` | Cancelado con Ctrl+C |
+
+<a name="formatos-es"></a>
+## Formatos de salida e integración en CI
+
+`-f/--format` elige el formato del informe: `txt` (por defecto), `json` o `md`. Con `-o -` el informe va a la salida estándar y la interfaz a stderr, así que se puede encadenar con otras herramientas:
+
+```bash
+uvx github-pages-auditor -u alberto2005-coder -f json -o - -q | jq '.summary'
+```
+
+**JSON** (`schema_version: 1`): `tool`, `generated_at`, `user`, `mode` (`api`/`web`), `summary` (contadores), `findings` (una lista por regla, vacía si no hay hallazgos), `fail_on` (reglas pedidas y disparadas) y `repos` (un objeto por repositorio, con `pages.status`, `pages.problems`, `pages.warnings`, `pages.title`, etc.).
+
+**Markdown** (`-f md`): tabla de tus demos en vivo, ordenada y sin forks, entre los marcadores `<!-- github-pages-auditor:start -->` y `<!-- github-pages-auditor:end -->`. Con `--inject README.md` se actualiza **dentro de ese archivo**, entre esos marcadores (si no existen, falla sin tocar nada).
+
+**Reglas de `--fail-on`:** `missing-readme`, `missing-license`, `missing-gitignore`, `missing-description`, `broken-pages`, `analysis-errors` o `any`. Ejemplo: `--fail-on missing-license,broken-pages`.
+
+**Salud de Pages.** Para cada sitio se comprueba, además del código 200: errores TLS, timeouts, redirecciones a otro dominio o en bucle, página vacía o sin HTML, y lentitud (aviso). Con **token** se sabe qué repos tienen Pages activadas, así que un 404, un build fallido (`errored`) o cualquier fallo cuenta como **Pages rotas**. Sin token no se puede saber si un repo *debería* tener Pages, por lo que un fallo solo significa "no hay Pages".
+
+**Ejemplo de CI (GitHub Actions):**
+
+```yaml
+- run: uvx github-pages-auditor -u ${{ github.repository_owner }} -k ${{ secrets.GITHUB_TOKEN }} -f json -o report.json --fail-on missing-license,broken-pages
+```
+
+<a name="pruebas-es"></a>
+## Pruebas automatizadas
+
+Los tests usan una sesión HTTP falsa: no tocan la red ni consumen cuota de GitHub.
+
+```bash
+uv run pytest          # o: pip install -r requirements-dev.txt && pytest
+```
+
+Cubren configuración y prioridades, cliente HTTP, ambos proveedores (API y web), orquestación en paralelo, informe, CLI, códigos de salida y créditos. La integración continua (GitHub Actions) los ejecuta en Linux, macOS y Windows con Python 3.10 y 3.13.
+
+<a name="estructura-es"></a>
+## Estructura del proyecto
+
+```text
+github-pages-auditor/
+├── .github/workflows/test.yml   # Integración continua
+├── .github/workflows/publish.yml # Publicación en PyPI
+├── .env.example                 # Plantilla opcional de variables
+├── .gitignore
+├── CHANGELOG.md                 # Historial de versiones
+├── LICENSE
+├── README.md
+├── pyproject.toml
+├── requirements.txt             # Dependencias para pip
+├── requirements-dev.txt         # + pytest
+├── uv.lock
+├── src/github_pages_auditor/
+│   ├── __init__.py              # Versión y créditos del autor
+│   ├── __main__.py              # python -m github_pages_auditor
+│   ├── main.py                  # Punto de entrada de la CLI
+│   ├── config.py                # Argumentos y entorno
+│   ├── audit.py                 # Orquestación en paralelo
+│   ├── github_api.py            # Proveedor: API oficial (con token)
+│   ├── github_web.py            # Proveedor: web pública (sin token)
+│   ├── http.py                  # Sesión con reintentos y timeout
+│   ├── pages.py                 # URLs de GitHub Pages
+│   ├── pages_health.py          # Salud de Pages (404, TLS, redirecciones...)
+│   ├── rules.py                 # Reglas de --fail-on
+│   ├── formatters.py            # Salidas JSON y Markdown
+│   ├── models.py                # Estructuras de datos
+│   ├── errors.py                # Excepciones propias
+│   └── report.py                # Consola (Rich) e informe .txt
+└── tests/                       # Suite de pytest
+```
+
+<a name="seguridad-es"></a>
+## Seguridad
+
+- El token se envía **únicamente** a `api.github.com`, nunca a `github.com`, `raw.githubusercontent.com` ni a tu dominio.
+- Un parámetro `-k` queda en el historial del shell: es preferible la variable `GITHUB_TOKEN`.
+- No subas tu `.env` a git (ya está en `.gitignore`). Para esta herramienta basta un token sin permisos especiales (repos públicos).
+
+<a name="autor-es"></a>
+## Autor
+
+Desarrollado por **Alberto Ortiz**.
+
+- GitHub: <https://github.com/alberto2005-coder/>
+- Web personal: <https://albertoortiz.is-a.dev/>
+
+<a name="licencia-es"></a>
+## Licencia
+
+Distribuido bajo la Licencia MIT. Consulta [LICENSE](https://github.com/alberto2005-coder/github-pages-auditor/blob/master/LICENSE).
+
+---
+
+<a name="english"></a>
+# English
+
+Python command-line tool that audits a GitHub user's public repositories: it maps **GitHub Pages** links (including a custom domain), detects **releases**, and checks repository quality (README, license, `.gitignore` and description).
+
+It is driven **entirely by command-line parameters**: no `.env` file needed. The **API token is optional**: with a token it uses the official GitHub API; without one it falls back to a best-effort public web mode.
+
+## Table of Contents
+
+1. [Features](#features-en)
+2. [Operating modes: with and without API](#modes-en)
+3. [Prerequisites](#prerequisites-en)
+4. [Installation](#installation-en)
+5. [Command-line usage](#usage-en)
+6. [Configuration precedence](#configuration-en)
+7. [Exit codes](#exit-en)
+8. [Output formats and CI integration](#formats-en)
+9. [Automated tests](#tests-en)
+10. [Project structure](#structure-en)
+11. [Security](#security-en)
+12. [Author](#author-en)
+13. [License](#license-en)
+
+---
+
+<a name="features-en"></a>
+## Features
+
+- **GitHub Pages mapping:** root (`<user>.github.io`) or per-repository subpath, verifying that the URL really responds.
+- **Releases:** detected through the public Atom feed, without using API quota.
+- **Quality audit:** missing README, license, `.gitignore` and description (About).
+- **Classification:** forks and archived repositories.
+- **Performance:** all checks run in parallel (`ThreadPoolExecutor`) with retries and timeouts.
+- **Deterministic report:** repositories always appear in the same order; a network failure on one repo does not abort the rest (it is listed separately).
+- **Author credits** in `--help`, `--version`, the console and the report.
+
+<a name="modes-en"></a>
+## Operating modes: with and without API
+
+| | With token (`-k` / `GITHUB_TOKEN`) | Without token |
+| :--- | :--- | :--- |
+| Data source | Official REST API (5,000 requests/hour) | Public GitHub pages (HTML, `raw`, Atom) |
+| Reliability | **High** | Best effort: depends on GitHub's public markup |
+| Limit | 5,000/h | May receive `429` if abused |
+| Enabled | Automatically when a token is present | When no token is given, or with `--no-api` |
+
+The token is **only ever sent to `api.github.com`**.
+
+**Pages URL:** with the API, the real URL configured on GitHub is used (including your custom domain). Without the API and without `-w`, `https://<user>.github.io/...` is tried and, if GitHub redirects to your custom domain, that domain is detected and shown. With `-w`, that domain is checked directly.
+
+<a name="prerequisites-en"></a>
+## Prerequisites
+
+- **Python** 3.10 or higher.
+- **Package manager:** [`uv`](https://docs.astral.sh/uv/) (recommended) or `pip`.
+
+<a name="installation-en"></a>
+## Installation
+
+- **Without installing anything (recommended), with [`uv`](https://docs.astral.sh/uv/):**
+  ```bash
+  uvx github-pages-auditor -u your_user
+  ```
+- **Install it as a command:** `uv tool install github-pages-auditor` or `pip install github-pages-auditor`.
+
+The old `ver-github-pages` command keeps working as an alias.
+
+To work from source:
+
+```bash
+git clone https://github.com/alberto2005-coder/github-pages-auditor.git
+cd github-pages-auditor
+```
+
+- **Using `uv` (recommended):**
+  ```bash
+  uv sync
+  ```
+- **Using `pip`:**
+  ```bash
+  pip install -e .
+  ```
+
+<a name="usage-en"></a>
+## Command-line usage
+
+```text
+github-pages-auditor -u USER [-w DOMAIN] [-k TOKEN] [-o FILE] [options]
+```
+
+**Examples**
+
+```bash
+# 1. Basic, no token and no .env (web mode)
+uv run github-pages-auditor -u alberto2005-coder
+
+# 2. Custom domain and token (API mode)
+uv run github-pages-auditor -u alberto2005-coder -w https://albertoortiz.is-a.dev -k ghp_your_token
+
+# 3. Force web mode even with a token, and change the output file
+uv run github-pages-auditor -u alberto2005-coder -k ghp_your_token --no-api -o my_report.txt
+
+# 4. Token from an environment variable (safer: not stored in shell history)
+GITHUB_TOKEN=ghp_your_token uv run github-pages-auditor -u alberto2005-coder
+
+# 5. Also works as a module
+python -m github_pages_auditor -u alberto2005-coder
+```
+
+**Options**
+
+| Flag | Aliases | Description | Required |
+| :--- | :--- | :--- | :--- |
+| `-u` | `--usuario`, `--user` | GitHub username | **Yes** (or `USUARIO_GITHUB`) |
+| `-w` | `--web`, `--dominio` | Base domain of the Pages site | No (default `https://<user>.github.io`) |
+| `-k` | `--key`, `--token` | Personal Access Token (enables the API) | No |
+| `-o` | `--output` | Report file; `-` = standard output | No (default `paginas_github.<format>`) |
+| `-f` | `--format` | `txt`, `json` or `md` | No (default `txt`) |
+| `--fail-on` | | Rules that cause exit code 1 (or `any`) | No |
+| `--exclude-forks` | | Ignore forks | No |
+| `--exclude-archived` | | Ignore archived repositories | No |
+| `--inject` | | Update the demos table inside a file (README) | No |
+| `-q` | `--quiet` | No tables or progress | No |
+| `--workers` | | Parallel threads | No (default `15`) |
+| `--timeout` | | Per-request timeout, in seconds | No (default `10`) |
+| `--no-api` | | Force web mode even with a token | No |
+| `--no-color` | | Colorless console output | No |
+| `--no-env` | | Do not read the `.env` file | No |
+| `-V` | `--version` | Version and credits | No |
+| `-h` | `--help` | Help and credits | No |
+
+<a name="configuration-en"></a>
+## Configuration precedence
+
+1. **Command-line parameters** (`-u`, `-w`, `-k`, `-o`…).
+2. **Environment variables**, including those from an **optional** `.env` file in the current directory: `USUARIO_GITHUB`, `DOMINIO_WEB`, `GITHUB_TOKEN`, `ARCHIVO_SALIDA`. An empty value counts as unset.
+3. **Built-in defaults.**
+
+A template is provided in [`.env.example`](https://github.com/alberto2005-coder/github-pages-auditor/blob/master/.env.example).
+
+<a name="exit-en"></a>
+## Exit codes
+
+| Code | Meaning |
+| :---: | :--- |
+| `0` | Audit succeeded and report written |
+| `1` | A `--fail-on` rule found issues (the report is still written) |
+| `2` | Error: invalid parameters, unknown user, rejected token, rate limit, network or write failure |
+| `3` | No repositories to analyze (no report is written) |
+| `130` | Cancelled with Ctrl+C |
+
+<a name="formats-en"></a>
+## Output formats and CI integration
+
+`-f/--format` selects the report format: `txt` (default), `json` or `md`. With `-o -` the report goes to standard output and the UI to stderr, so it can be piped:
+
+```bash
+uvx github-pages-auditor -u alberto2005-coder -f json -o - -q | jq '.summary'
+```
+
+**JSON** (`schema_version: 1`): `tool`, `generated_at`, `user`, `mode` (`api`/`web`), `summary` (counters), `findings` (one list per rule, empty when clean), `fail_on` (requested and triggered rules) and `repos` (one object per repository, with `pages.status`, `pages.problems`, `pages.warnings`, `pages.title`, etc.).
+
+**Markdown** (`-f md`): a sorted table of your live demos, forks excluded, between the `<!-- github-pages-auditor:start -->` and `<!-- github-pages-auditor:end -->` markers. `--inject README.md` updates it **inside that file**, between those markers (if they are missing it fails without touching anything).
+
+**`--fail-on` rules:** `missing-readme`, `missing-license`, `missing-gitignore`, `missing-description`, `broken-pages`, `analysis-errors` or `any`. Example: `--fail-on missing-license,broken-pages`.
+
+**Pages health.** Besides a 200 status, each site is checked for TLS errors, timeouts, redirects to another domain or loops, empty or non-HTML pages, and slowness (warning). With a **token** the tool knows which repos have Pages enabled, so a 404, a failed build (`errored`) or any failure counts as **broken Pages**. Without a token it cannot know whether a repo *should* have Pages, so a failure just means "no Pages".
+
+**CI example (GitHub Actions):**
+
+```yaml
+- run: uvx github-pages-auditor -u ${{ github.repository_owner }} -k ${{ secrets.GITHUB_TOKEN }} -f json -o report.json --fail-on missing-license,broken-pages
+```
+
+<a name="tests-en"></a>
+## Automated tests
+
+Tests use a fake HTTP session: they never touch the network or use GitHub quota.
+
+```bash
+uv run pytest          # or: pip install -r requirements-dev.txt && pytest
+```
+
+They cover configuration and precedence, the HTTP client, both providers (API and web), parallel orchestration, the report, the CLI, exit codes and credits. Continuous integration (GitHub Actions) runs them on Linux, macOS and Windows with Python 3.10 and 3.13.
+
+<a name="structure-en"></a>
+## Project structure
+
+```text
+github-pages-auditor/
+├── .github/workflows/test.yml   # Continuous integration
+├── .github/workflows/publish.yml # PyPI publishing
+├── .env.example                 # Optional variables template
+├── .gitignore
+├── CHANGELOG.md                 # Version history
+├── LICENSE
+├── README.md
+├── pyproject.toml
+├── requirements.txt             # pip dependencies
+├── requirements-dev.txt         # + pytest
+├── uv.lock
+├── src/github_pages_auditor/
+│   ├── __init__.py              # Version and author credits
+│   ├── __main__.py              # python -m github_pages_auditor
+│   ├── main.py                  # CLI entry point
+│   ├── config.py                # Arguments and environment
+│   ├── audit.py                 # Parallel orchestration
+│   ├── github_api.py            # Provider: official API (with token)
+│   ├── github_web.py            # Provider: public web (no token)
+│   ├── http.py                  # Session with retries and timeout
+│   ├── pages.py                 # GitHub Pages URLs
+│   ├── pages_health.py          # Pages health (404, TLS, redirects...)
+│   ├── rules.py                 # --fail-on rules
+│   ├── formatters.py            # JSON and Markdown output
+│   ├── models.py                # Data structures
+│   ├── errors.py                # Custom exceptions
+│   └── report.py                # Console (Rich) and .txt report
+└── tests/                       # pytest suite
+```
+
+<a name="security-en"></a>
+## Security
+
+- The token is sent **only** to `api.github.com`, never to `github.com`, `raw.githubusercontent.com` or your own domain.
+- A `-k` parameter is stored in your shell history: prefer the `GITHUB_TOKEN` environment variable.
+- Do not commit your `.env` (it is already in `.gitignore`). A token with no special scopes (public repos) is enough for this tool.
+
+<a name="author-en"></a>
+## Author
+
+Developed by **Alberto Ortiz**.
+
+- GitHub: <https://github.com/alberto2005-coder/>
+- Personal website: <https://albertoortiz.is-a.dev/>
+
+<a name="license-en"></a>
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/alberto2005-coder/github-pages-auditor/blob/master/LICENSE).

github_pages_auditor-1.2.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+github_pages_auditor/__init__.py,sha256=31LPx-um40rdUM4CHA7JJmIFlaM5h5jHUzC-jhnCufw,477
+github_pages_auditor/__main__.py,sha256=cwKJAAML0RRKT9Qbzcwf07HHcuSd8oh7kx4P1apndWQ,84
+github_pages_auditor/audit.py,sha256=nZYlQ-X4lhlRTqUs3613HXn7YihRDGdqt_hT2OVzXlI,3761
+github_pages_auditor/config.py,sha256=emudswKjvBoTnbFXcfyJxrJZaAkRgVuHeKwXaUm09LM,7302
+github_pages_auditor/errors.py,sha256=pmcUPiiJTRlz0q0adM1gBEn7LmuEFfo_zNm5PfeUWdQ,527
+github_pages_auditor/formatters.py,sha256=Uz8O-2WDkHC9QVmKwJJxBCpGEEIZxEolaQgjDP2myU8,4658
+github_pages_auditor/github_api.py,sha256=ng4Liho2J-TIYTmq0WnrFnaDAsO_Bfy2NIvR-iAKyDQ,5792
+github_pages_auditor/github_web.py,sha256=efKzVjjDSKAvn3FMkbA_HU6XYvMKlAV-jjqj-d0mpJ8,4754
+github_pages_auditor/http.py,sha256=SgTjwUqLw1Qqk_PBqBl-cbhxPlLMS1WV625D_BPdiMY,1634
+github_pages_auditor/main.py,sha256=Zn3XritrLsdkCUzuT-8_XAAkNLoNcLa2lBnEwVeLvTs,4363
+github_pages_auditor/models.py,sha256=MvHJMBI4Dsy8XKMrNwBRrjmOwJ9juk8wwB4ZdsQLyZs,3863
+github_pages_auditor/pages.py,sha256=8J-pY6wxspKFVHfoRT6n2AcNcH6w_WuyXfAiV5Su0z8,1782
+github_pages_auditor/pages_health.py,sha256=n_xD1kVw2aNrz_cJHx4QLek8LVQ6sWZQ74I0fwl-vXo,3811
+github_pages_auditor/report.py,sha256=PcQzwIARyfBObDLhjTGAyRv5sPaZugArqAzpdQA2yC8,4854
+github_pages_auditor/rules.py,sha256=Mvy9edRUEf84DBC6Arf3XLZrVUStAbEcekpB7ammX-I,1883
+github_pages_auditor-1.2.0.dist-info/licenses/LICENSE,sha256=wNZmqqZg01ZnCIXzwsBOS8y4vCGmJPvG7MXbcbGfgMQ,1069
+github_pages_auditor-1.2.0.dist-info/WHEEL,sha256=3OmCxFA0ffBIsX4x0o8CdfSvZAOvO3mzEG8U_z5TvV4,80
+github_pages_auditor-1.2.0.dist-info/entry_points.txt,sha256=oX2j9yyCGDBEkfiUX-R4spIG_0McoYTzaISzdbrupDc,123
+github_pages_auditor-1.2.0.dist-info/METADATA,sha256=j1m1n4YAFRYHKrGuZOk-Bj7c_Kj1fKIL8qyBPFAVOa0,23835
+github_pages_auditor-1.2.0.dist-info/RECORD,,

github_pages_auditor-1.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.13.8
+Root-Is-Purelib: true
+Tag: py3-none-any

github_pages_auditor-1.2.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+github-pages-auditor = github_pages_auditor.main:main
+ver-github-pages = github_pages_auditor.main:main
+

github_pages_auditor-1.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alberto Ortiz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.