easycontract 0.1.0__tar.gz

easycontract-0.1.0/.gitignore

@@ -0,0 +1,187 @@
+# Project
+.claude
+.idea
+
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+
+# Django project artifacts
+staticfiles/
+media/
+
+# CSS build tooling (scripts/build_css.sh downloads pinned binaries here)
+.tools/

easycontract-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog — easycontract Python SDK
+
+## 0.1.0 (unreleased)
+
+First public release. Notes for integrators:
+
+- `EasyContract.request(..., idempotency_key=...)`: `None` (default) and `True`
+  generate a UUID per logical request, reused across retries; `False` sends no
+  header; any other value (a `str`, a `uuid.UUID`…) is sent as `str(value)`.
+- Uploads: file objects passed in `files` are closed once the request finishes.
+  A non-seekable stream (pipe, socket) is sent once and never retried; pass a
+  path, `bytes` or a seekable file to get 429 retries.
+- `webhooks.verify_signature`: `tolerance=0` is strict; only `tolerance=None`
+  disables the replay window. Verification runs over the raw bytes and every
+  failure raises `SignatureVerificationError`, never a decode/parse error.
+- Auto-pagination raises `EasyContractError` on a page without `data` or on a
+  cursor that does not advance, instead of looping or crashing.
+- Runtime dependency pinned to `requests>=2.31,<3`. Licence declared as
+  `LicenseRef-easycontract-proprietary` (PEP 639) with `LICENSE.txt`.

easycontract-0.1.0/LICENSE.txt

@@ -0,0 +1,18 @@
+easycontract Python SDK
+
+Copyright (c) 2026 Román Ramírez — roman@easycontract.online
+
+Proprietary. All rights reserved.
+
+This software and its documentation are proprietary to easycontract. No
+rights are granted to use, modify, reproduce, distribute, or create
+derivative works of this software, except as expressly agreed in writing
+with easycontract (for example, under an applicable customer agreement).
+
+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.

easycontract-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.5
+Name: easycontract
+Version: 0.1.0
+Summary: SDK oficial de Python para el API de easycontract (firma electrónica eIDAS)
+Project-URL: Documentation, https://easycontract.online/docs/api
+Author-email: Román Ramírez <roman@easycontract.online>
+License-Expression: LicenseRef-easycontract-proprietary
+License-File: LICENSE.txt
+Keywords: audit-trail,contract,e-signature,eidas,esign,webhooks
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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 :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: requests<3,>=2.31
+Description-Content-Type: text/markdown
+
+# easycontract — SDK de Python
+
+SDK oficial del API de firma electrónica de easycontract (SES/AdES bajo eIDAS,
+con paquete de evidencias defendible en litigio).
+
+```bash
+pip install easycontract
+```
+
+```python
+from easycontract import EasyContract
+
+client = EasyContract(api_key="ec_test_...")  # ec_live_... en producción
+print(client.whoami())
+```
+
+- **Modo test de primera clase**: una clave `ec_test_…` opera sobre datos
+  aislados (TSA/PAdES simulados). Nadie debería firmar un documento real para
+  probar la integración.
+- **Idempotencia automática**: todo POST lleva `Idempotency-Key` (uuid4);
+  pásala tú misma para reintentos seguros de tu lado.
+- **Reintentos**: 429 (respetando `Retry-After`) y 5xx en GETs.
+- **Errores tipados** con el `code` estable del API:
+  `AuthenticationError`, `RateLimitError`, `ForbiddenError` (cuota/feature/
+  regla de membresía), `InvalidRequestError`, `NotFoundError`,
+  `ConflictError`, `ServerError`.
+
+---
+
+## Receta 1 — Enviar un envelope desde plantilla (el flujo RootedCON)
+
+Una sola llamada: cubre los roles, envía, y recibe los enlaces de firma.
+
+```python
+result = client.templates.create_envelope(
+    template_id,
+    signers={"ponente": {"full_name": "Ada Lovelace", "email": "ada@example.com"}},
+    title="Contrato ponencia RootedCON 2027 — Ada Lovelace",
+    send=True,  # congela hashes, plan y retención, y acuña enlaces
+    deliver_emails=True,  # easycontract envía los emails con los enlaces
+)
+envelope_id = result["envelope"]["id"]
+```
+
+Creación de la plantilla (una vez):
+
+```python
+template = client.templates.create(name="Contrato ponente", retention_period_months=72)
+doc = client.templates.add_document(template["id"], file="contrato-ponente.pdf")
+client.templates.add_role(template["id"], key="ponente", label="Ponente")
+client.templates.add_field(
+    template["id"],
+    document_id=doc["id"],
+    role="ponente",
+    anchor_text="Fdo. el ponente:",  # la firma se estampa donde el PDF lo dice
+)
+```
+
+## Receta 2 — Firma embebida (embedded signing)
+
+Con `deliver_emails=False` recibes el `sign_url` de un solo uso por firmante y
+lo integras en tu propia aplicación (redirect o iframe):
+
+```python
+result = client.templates.create_envelope(
+    template_id,
+    signers={...},
+    send=True,
+    deliver_emails=False,
+)
+sign_url = result["signers"][0]["sign_url"]
+# → redirige al ponente a sign_url sin salir de tu flujo
+```
+
+El enlace es personal, caduca (14 días por defecto, `expires_in_days` para
+cambiarlo) y queda invalidado al firmar o rechazar.
+
+## Receta 3 — Webhooks vs. polling
+
+**Webhooks** (recomendado): registra un endpoint y verifica CADA entrega.
+
+```python
+endpoint = client.webhooks.create(url="https://miapp.com/hooks/easycontract")
+WEBHOOK_SECRET = endpoint["secret"]  # whsec_… — se muestra UNA sola vez
+
+# En tu receptor (Django/Flask/FastAPI):
+from easycontract import webhooks
+
+event = webhooks.verify_signature(
+    payload=request.body,
+    header=request.headers["X-EasyContract-Signature"],
+    secret=WEBHOOK_SECRET,
+)
+if event["type"] == "envelope.completed":
+    ...
+```
+
+**Reconciliación / polling**: los webhooks son la proyección de un event log
+consultable; si pierdes una entrega, reconcilia:
+
+```python
+for event in client.events.auto_paging_iter(type="envelope.completed"):
+    ...
+```
+
+## Receta 4 — Descargar el paquete de evidencias
+
+El ZIP completo (documentos, certificado, audit trail JSON verificable
+offline, sellos TSA) — lo que un tenant llevaría a un juzgado:
+
+```python
+client.envelopes.download_evidence(envelope_id, to="evidencias.zip")
+client.envelopes.download_certificate(envelope_id, to="certificado.pdf")
+```
+
+## Receta 5 — Gestión de plantillas
+
+```python
+for template in client.templates.list()["data"]:
+    print(template["name"])
+
+detail = client.templates.get(template_id, expand=["documents", "roles", "fields"])
+client.templates.delete(old_template_id)
+```
+
+---
+
+## Envelope manual (sin plantilla)
+
+```python
+envelope = client.envelopes.create(
+    title="NDA",
+    retention_period_months=60,  # retención SIEMPRE explícita
+)
+client.envelopes.add_document(envelope["id"], file="nda.pdf")
+client.envelopes.add_signer(
+    envelope["id"],
+    full_name="Grace Hopper",
+    email="grace@example.com",
+    auth_methods=["email_link", "sms_otp"],
+    phone="+34600111222",  # OTP: plan Pro+
+)
+sent = client.envelopes.send(envelope["id"])
+```
+
+## Organización, miembros e invitaciones
+
+```python
+org = client.organization.get()  # plan, límites y features del plan
+members = client.members.list()
+invite = client.invitations.create(email="colega@example.com", role="member")
+# invite["accept_url"] — entrégalo tú o deja que easycontract lo envíe por email
+```

easycontract-0.1.0/README.md

@@ -0,0 +1,153 @@
+# easycontract — SDK de Python
+
+SDK oficial del API de firma electrónica de easycontract (SES/AdES bajo eIDAS,
+con paquete de evidencias defendible en litigio).
+
+```bash
+pip install easycontract
+```
+
+```python
+from easycontract import EasyContract
+
+client = EasyContract(api_key="ec_test_...")  # ec_live_... en producción
+print(client.whoami())
+```
+
+- **Modo test de primera clase**: una clave `ec_test_…` opera sobre datos
+  aislados (TSA/PAdES simulados). Nadie debería firmar un documento real para
+  probar la integración.
+- **Idempotencia automática**: todo POST lleva `Idempotency-Key` (uuid4);
+  pásala tú misma para reintentos seguros de tu lado.
+- **Reintentos**: 429 (respetando `Retry-After`) y 5xx en GETs.
+- **Errores tipados** con el `code` estable del API:
+  `AuthenticationError`, `RateLimitError`, `ForbiddenError` (cuota/feature/
+  regla de membresía), `InvalidRequestError`, `NotFoundError`,
+  `ConflictError`, `ServerError`.
+
+---
+
+## Receta 1 — Enviar un envelope desde plantilla (el flujo RootedCON)
+
+Una sola llamada: cubre los roles, envía, y recibe los enlaces de firma.
+
+```python
+result = client.templates.create_envelope(
+    template_id,
+    signers={"ponente": {"full_name": "Ada Lovelace", "email": "ada@example.com"}},
+    title="Contrato ponencia RootedCON 2027 — Ada Lovelace",
+    send=True,  # congela hashes, plan y retención, y acuña enlaces
+    deliver_emails=True,  # easycontract envía los emails con los enlaces
+)
+envelope_id = result["envelope"]["id"]
+```
+
+Creación de la plantilla (una vez):
+
+```python
+template = client.templates.create(name="Contrato ponente", retention_period_months=72)
+doc = client.templates.add_document(template["id"], file="contrato-ponente.pdf")
+client.templates.add_role(template["id"], key="ponente", label="Ponente")
+client.templates.add_field(
+    template["id"],
+    document_id=doc["id"],
+    role="ponente",
+    anchor_text="Fdo. el ponente:",  # la firma se estampa donde el PDF lo dice
+)
+```
+
+## Receta 2 — Firma embebida (embedded signing)
+
+Con `deliver_emails=False` recibes el `sign_url` de un solo uso por firmante y
+lo integras en tu propia aplicación (redirect o iframe):
+
+```python
+result = client.templates.create_envelope(
+    template_id,
+    signers={...},
+    send=True,
+    deliver_emails=False,
+)
+sign_url = result["signers"][0]["sign_url"]
+# → redirige al ponente a sign_url sin salir de tu flujo
+```
+
+El enlace es personal, caduca (14 días por defecto, `expires_in_days` para
+cambiarlo) y queda invalidado al firmar o rechazar.
+
+## Receta 3 — Webhooks vs. polling
+
+**Webhooks** (recomendado): registra un endpoint y verifica CADA entrega.
+
+```python
+endpoint = client.webhooks.create(url="https://miapp.com/hooks/easycontract")
+WEBHOOK_SECRET = endpoint["secret"]  # whsec_… — se muestra UNA sola vez
+
+# En tu receptor (Django/Flask/FastAPI):
+from easycontract import webhooks
+
+event = webhooks.verify_signature(
+    payload=request.body,
+    header=request.headers["X-EasyContract-Signature"],
+    secret=WEBHOOK_SECRET,
+)
+if event["type"] == "envelope.completed":
+    ...
+```
+
+**Reconciliación / polling**: los webhooks son la proyección de un event log
+consultable; si pierdes una entrega, reconcilia:
+
+```python
+for event in client.events.auto_paging_iter(type="envelope.completed"):
+    ...
+```
+
+## Receta 4 — Descargar el paquete de evidencias
+
+El ZIP completo (documentos, certificado, audit trail JSON verificable
+offline, sellos TSA) — lo que un tenant llevaría a un juzgado:
+
+```python
+client.envelopes.download_evidence(envelope_id, to="evidencias.zip")
+client.envelopes.download_certificate(envelope_id, to="certificado.pdf")
+```
+
+## Receta 5 — Gestión de plantillas
+
+```python
+for template in client.templates.list()["data"]:
+    print(template["name"])
+
+detail = client.templates.get(template_id, expand=["documents", "roles", "fields"])
+client.templates.delete(old_template_id)
+```
+
+---
+
+## Envelope manual (sin plantilla)
+
+```python
+envelope = client.envelopes.create(
+    title="NDA",
+    retention_period_months=60,  # retención SIEMPRE explícita
+)
+client.envelopes.add_document(envelope["id"], file="nda.pdf")
+client.envelopes.add_signer(
+    envelope["id"],
+    full_name="Grace Hopper",
+    email="grace@example.com",
+    auth_methods=["email_link", "sms_otp"],
+    phone="+34600111222",  # OTP: plan Pro+
+)
+sent = client.envelopes.send(envelope["id"])
+```
+
+## Organización, miembros e invitaciones
+
+```python
+org = client.organization.get()  # plan, límites y features del plan
+members = client.members.list()
+invite = client.invitations.create(email="colega@example.com", role="member")
+# invite["accept_url"] — entrégalo tú o deja que easycontract lo envíe por email
+```

easycontract-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "easycontract"
+version = "0.1.0"
+description = "SDK oficial de Python para el API de easycontract (firma electrónica eIDAS)"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "LicenseRef-easycontract-proprietary"
+authors = [{ name = "Román Ramírez", email = "roman@easycontract.online" }]
+keywords = ["e-signature", "eidas", "esign", "contract", "webhooks", "audit-trail"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "requests>=2.31,<3",
+]
+
+[project.urls]
+Documentation = "https://easycontract.online/docs/api"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/easycontract"]
+
+[tool.hatch.build.targets.sdist]
+# Internal material never ships in the sdist. (hatchling still adds the
+# repo-root .gitignore to the sdist; it holds nothing sensitive.)
+exclude = ["SECURITY-AUDIT*.md", "dist/"]

easycontract-0.1.0/src/easycontract/__init__.py

@@ -0,0 +1,40 @@
+"""easycontract — SDK oficial de Python.
+
+from easycontract import EasyContract
+
+client = EasyContract(api_key="ec_test_...")
+envelope = client.envelopes.create(title="Contrato", retention_period_months=72)
+"""
+
+__version__ = "0.1.0"
+
+from . import webhooks
+from .client import EasyContract
+from .errors import (
+    APIError,
+    AuthenticationError,
+    ConflictError,
+    EasyContractError,
+    ForbiddenError,
+    InvalidRequestError,
+    NotFoundError,
+    RateLimitError,
+    ServerError,
+    SignatureVerificationError,
+)
+
+__all__ = [
+    "EasyContract",
+    "EasyContractError",
+    "APIError",
+    "AuthenticationError",
+    "ForbiddenError",
+    "NotFoundError",
+    "InvalidRequestError",
+    "ConflictError",
+    "RateLimitError",
+    "ServerError",
+    "SignatureVerificationError",
+    "webhooks",
+    "__version__",
+]