Οδηγός αναφοράς digna Python SDK 2026.06¶
Αυτή η ενότητα τεκμηριώνει το Python SDK για το digna. Είναι οργανωμένη ως αναφορά πολλών σελίδων: χρησιμοποιήστε αυτή την επισκόπηση για να κατανοήσετε τον client και συνεχίστε στη συνέχεια με τις ξεχωριστές σελίδες για τη γρήγορη εκκίνηση, τους πόρους, τα μοντέλα, τα σφάλματα και την αυτόματα παραγόμενη τεκμηρίωση API.
Το SDK δημοσιεύεται ως πακέτο digna-sdk και προσφέρει έναν σταθερό client με έκδοση για το REST API του digna.
Βασικά στοιχεία του SDK¶
Επισκόπηση¶
Το SDK ακολουθεί έναν σχεδιασμό client προσανατολισμένο στους πόρους. Κάθε περιοχή του API διατίθεται ως αυτοτελής client στο ανώτερο αντικείμενο DignaClient, με τυποποιημένα μοντέλα αιτήματος και απόκρισης και συνεπή διαχείριση σφαλμάτων.
from digna_sdk import DignaClient
client = DignaClient(
base_url="https://your-digna-instance",
token="...",
)
Βασικά χαρακτηριστικά¶
- Τυποποιημένα μοντέλα — κάθε αίτημα και κάθε απόκριση επικυρώνεται με το pydantic, ώστε ο επεξεργαστής και ο έλεγχος τύπων να εντοπίζουν τα λάθη πριν από την κλήση στο δίκτυο.
- Προσανατολισμός στους πόρους —
client.projects,client.data_sources,client.data_sets,client.attributes,client.check_definitions,client.db_connections,client.inspection_requestsκαιclient.inspection_statusesπροσφέρουν ο καθένας απλές μεθόδουςlist/get/create/update/delete. - Σαφή σφάλματα — τα σφάλματα του API εγείρουν
DignaAPIError(ή μια πιο ειδική υποκλάση, όπωςDignaAuthenticationError,DignaAuthorizationErrorήDignaNotFoundError) αντί να επιστρέφουν σιωπηλάNone.
Εγκατάσταση¶
Σελίδες αναφοράς¶
Αυτή η έκδοση είναι οργανωμένη στις εξής σελίδες:
- Γρήγορη εκκίνηση — σύνδεση και πρώτες κλήσεις.
- Πόροι — ο πλήρης κατάλογος των διαθέσιμων clients πόρων.
- Μοντέλα — τα μοντέλα pydantic που χρησιμοποιούνται για είσοδο και έξοδο.
- Σφάλματα — η ιεραρχία των εξαιρέσεων.
- Αναφορά API — αυτόματα παραγόμενη τεκμηρίωση αναφοράς.