Skip to content

Enfoca el README del SDK Python en quienes usan la biblioteca - #2

Merged
mijhaels merged 1 commit into
mainfrom
docs/readme-para-usuarios
Oct 12, 2026
Merged

mijhaels merged 1 commit into
mainfrom
docs/readme-para-usuarios

Conversation

@mijhaels

Copy link
Copy Markdown
Contributor

Summary

pyproject.toml usa el README como descripción en PyPI, y casi la mitad trataba de uv, Ruff, el lockfile y la publicación.

 README.md   (211 → 151 líneas)
   Instalación · Cliente síncrono · Cliente asíncrono
   Parámetros y respuestas
+    Configuración   # timeout y redirecciones
+  Errores           # ValueError/LengthError y httpx.RequestError
   Migración desde las funciones anteriores
-  Desarrollo y pruebas   # uv, Ruff, build, wheel, CI, PyPI
+CONTRIBUTING.md          # todo lo de desarrollo, sin perder información

Los enlaces a CHANGELOG.md y CONTRIBUTING.md son absolutos para que funcionen en PyPI.

Evidence

  • Before: la descripción en PyPI incluía comandos de uv lock, twine y secretos de CI.
    After: uv build + twine check dist/* pasan para el wheel y el sdist con el README nuevo.

Merge Danger

Door: two-way

Solo cambia documentación.

Blast Radius: Documentación

PyPI muestra el README nuevo cuando se publique la próxima versión.

🤖 Generated with Claude Code

Move development, build and release instructions to CONTRIBUTING.md.
Document validation and transport errors, and use absolute links so
they resolve on PyPI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mijhaels
mijhaels merged commit 67b7e4e into main Oct 12, 2026
7 checks passed
@mijhaels
mijhaels deleted the docs/readme-para-usuarios branch October 27, 2026 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant