Type-safe Python models for for all GoCardless events using Pydantic

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for oliverlambson from gravatar.com oliverlambson

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (Copyright 2024 Karoo Permission is hereby granted, free of charge, to any person obtaining a copy o...)
  • Tags gocardless , pydantic
  • Requires: Python >=3.13
Classifiers
Report project as malware

Project description

gocardless event schemas

This is an unofficial library. GoCardless provide the gocardless-pro python library. The reason this exists is because that library is not typed.

Type-safe Python models for for all GoCardless events (using Pydantic).

This is a Python implementation of the Event Actions in the GoCardless docs.

Since we only use Python 3.13+ this library doesn't support older versions, but PRs are welcome.

Why does this exist

GoCardless' docs are good, but they don't publish an OpenAPI spec or JSON schemas for their events. Their Python client library is untyped, so deserialization of the events is not type-safe.

How it's made

We pulled all the event specs from the GoCardless docs site as HTML, cleaned them, preproccessed them into a JSON pseudo-schema, and then generated Pydantic models from that schema.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for oliverlambson from gravatar.com oliverlambson

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (Copyright 2024 Karoo Permission is hereby granted, free of charge, to any person obtaining a copy o...)
  • Tags gocardless , pydantic
  • Requires: Python >=3.13
Classifiers

Release history Release notifications | RSS feed

This version

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Download files

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

Source Distribution

gocardless_events-0.1.4.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

gocardless_events-0.1.4-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file gocardless_events-0.1.4.tar.gz.

File metadata

  • Download URL: gocardless_events-0.1.4.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for gocardless_events-0.1.4.tar.gz
Algorithm Hash digest
SHA256 71979cbf93292c574ba8632619231d71b93728b109adf85b84d5f47d1a7ed778
MD5 ffa6d69935cdcf66d7e73599227e73a3
BLAKE2b-256 c94c4f69a629d508806d0626b3ceff6dda05841127d5235df8b7c42856919ed5

See more details on using hashes here.

Provenance

The following attestation bundles were made for gocardless_events-0.1.4.tar.gz:

Publisher: publish.yaml on karoo-ca/gocardless-events

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gocardless_events-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for gocardless_events-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fb85ac9a7f51724cceb56e781aac7a97c958382960e9b10fcd3b6f898793c220
MD5 4fa4b0fb8e808e619e622271f5db77c7
BLAKE2b-256 ce3246b48711c0bd92ad8625d0f598565cfafc6ed94e11c7b1f458f484dbf1c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for gocardless_events-0.1.4-py3-none-any.whl:

Publisher: publish.yaml on karoo-ca/gocardless-events

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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