Skip to main content

Official Python SDK for the EnfermerIA Public API.

Project description

EnfermerIA Python SDK

SDK oficial de Python para consumir la API publica de EnfermerIA sin tener que montar manualmente el flujo de subida, creacion de jobs y polling.

Requisitos

  • Python 3.9+
  • Sin dependencias runtime externas

Instalacion

Instalacion local desde ruta del disco

Desde otro proyecto consumidor:

pip install C:\ruta\al\repo\sdk\python

O con una ruta relativa:

pip install ../EnfermerIA/sdk/python

Desarrollo local en modo editable

cd sdk/python
pip install -e .

Publicacion futura en PyPI

El paquete ya queda preparado para publicarse mas adelante como enfermeria-sdk, sin cambios estructurales grandes.

Configuracion

from enfermeria import EnfermerIAClient

client = EnfermerIAClient(
    api_key="YOUR_API_KEY",
    base_url="https://enfermer-ia.com/api",
    timeout_ms=30_000,
)

base_url acepta tanto la raiz del sitio (https://enfermer-ia.com) como la raiz de la API (https://enfermer-ia.com/api). Para local puedes usar http://localhost:3000 o http://localhost:3000/api.

Ejemplo minimo

from pathlib import Path

from enfermeria import EnfermerIAClient

client = EnfermerIAClient(api_key="YOUR_API_KEY")

result = client.analyze_image_and_wait(
    file=Path("./talon.png"),
    clinical_context="Paciente con ulcera en talon",
)

print(result)

Ejemplo paso a paso

from pathlib import Path

from enfermeria import EnfermerIAClient

client = EnfermerIAClient(api_key="YOUR_API_KEY")

job = client.analyze_image(
    file=Path("./talon.png"),
    clinical_context="Paciente con ulcera en talon",
)

result = client.wait_for_job(job.job_id)
print(result)

Inputs soportados para file

  • str con ruta local
  • pathlib.Path
  • bytes
  • bytearray
  • memoryview

Reglas de inferencia

filename

El SDK intenta inferir filename en este orden:

  1. filename explicito.
  2. El nombre de la ruta local si file es str o Path.
  3. Un fallback basado en el MIME, por ejemplo upload.png.
  4. Si no hay pistas, upload.bin.

content_type

El SDK intenta inferir content_type en este orden:

  1. content_type explicito.
  2. La extension de filename.
  3. La extension de la ruta local si file es str o Path.
  4. Fallback interno application/octet-stream.

Extensiones soportadas por inferencia:

  • png -> image/png
  • jpg/jpeg -> image/jpeg
  • webp -> image/webp
  • gif -> image/gif
  • bmp -> image/bmp
  • tif/tiff -> image/tiff

Si el SDK no puede inferir un MIME suficientemente claro, lanza un error explicito pidiendo filename o content_type.

Metodos principales

  • get_upload_url()
  • upload_file_to_signed_url()
  • create_analysis_job()
  • get_job()
  • wait_for_job()
  • analyze_image()
  • analyze_image_and_wait()

Manejo de errores

from enfermeria import EnfermerIAApiError, EnfermerIAClient, EnfermerIAJobError

client = EnfermerIAClient(api_key="YOUR_API_KEY")

try:
    result = client.analyze_image_and_wait(file="./talon.png")
    print(result)
except EnfermerIAApiError as error:
    print(error.status_code, error.endpoint, error.api_message)
except EnfermerIAJobError as error:
    print(error.job_id, error.api_message)

Tipos devueltos

  • UploadUrlResponse
  • AnalysisJobResponse
  • GetJobResponse
  • AnalyzeImageResponse
  • WaitForJobOptions

Como probarlo contra produccion

client = EnfermerIAClient(
    api_key="YOUR_API_KEY",
    base_url="https://enfermer-ia.com",
)

Como probarlo contra localhost

client = EnfermerIAClient(
    api_key="YOUR_API_KEY",
    base_url="http://localhost:3000",
)

Ejemplos incluidos

  • examples/basic.py
  • examples/analyze_and_wait.py
  • examples/from_path.py
  • examples/from_bytes.py

Desarrollo

cd sdk/python
python -m unittest discover -s tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

enfermeria_sdk-0.1.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enfermeria_sdk-0.1.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file enfermeria_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: enfermeria_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for enfermeria_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2d5e78ffbfcbb0c86a0be80b98587881deb4b36e5b94bb79fc0dd48cadcf4557
MD5 60cd4f4238d5aa1c0b3fbf2643ab2c51
BLAKE2b-256 263c57bed816724f69bcb67afb77ab35da8fe71b7b2c03756da1b5839189424a

See more details on using hashes here.

File details

Details for the file enfermeria_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: enfermeria_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for enfermeria_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f96e49d431711ac3ab4b5b085fd801597402f9215b96ae5d4aea57c2b572c1e8
MD5 7a4405b40d8df47a2d0e856f5c5192c1
BLAKE2b-256 7639e4195e42da5724dc7b45432edd9d7d6f7f76f10d87fe795b88e40695a28e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page