| Name | gocardless-events JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Type-safe Python models for for all GoCardless events using Pydantic |
| upload_time | 2024-12-30 17:15:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.13 |
| license | Copyright 2024 Karoo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 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. |
| keywords |
gocardless
pydantic
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# gocardless event schemas
> This is an unofficial library. GoCardless provide the [gocardless-pro python library](https://pypi.org/project/gocardless-pro/).
> 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](https://developer.gocardless.com/api-reference#event-actions).
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "gocardless-events",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "gocardless, pydantic",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ec/ba/805a58a2aa58bce5a5aaa0b23862b554df2761c0665601095bb4713041a1/gocardless_events-0.1.3.tar.gz",
"platform": null,
"description": "# gocardless event schemas\n\n> This is an unofficial library. GoCardless provide the [gocardless-pro python library](https://pypi.org/project/gocardless-pro/).\n> The reason this exists is because that library is not typed.\n\nType-safe Python models for for all GoCardless events (using Pydantic).\n\nThis is a Python implementation of the Event Actions in the [GoCardless docs](https://developer.gocardless.com/api-reference#event-actions).\n\nSince we only use Python 3.13+ this library doesn't support older versions, but\nPRs are welcome.\n\n## Why does this exist\n\nGoCardless' docs are good, but they don't publish an OpenAPI spec or JSON schemas for\ntheir events. Their Python client library is untyped, so deserialization of the events\nis not type-safe.\n\n## How it's made\n\nWe pulled all the event specs from the GoCardless docs site as HTML, cleaned\nthem, preproccessed them into a JSON pseudo-schema, and then generated Pydantic\nmodels from that schema.\n",
"bugtrack_url": null,
"license": "Copyright 2024 Karoo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, 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.",
"summary": "Type-safe Python models for for all GoCardless events using Pydantic",
"version": "0.1.3",
"project_urls": {
"Issues": "https://github.com/karoo-ca/gocardless-events/issues",
"Repository": "https://github.com/karoo-ca/gocardless-events.git"
},
"split_keywords": [
"gocardless",
" pydantic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "557139610cb39a0ea692daf330c4d83881eda4d92255593ea8428ba2c2258a60",
"md5": "192b7c4138521bfe00202ca2b15c1d87",
"sha256": "e6e807c222d2b1573cd0aee5200f10d2349cbd59a4f3f2e4d6ed003ef273cf9c"
},
"downloads": -1,
"filename": "gocardless_events-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "192b7c4138521bfe00202ca2b15c1d87",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 22899,
"upload_time": "2024-12-30T17:15:50",
"upload_time_iso_8601": "2024-12-30T17:15:50.946332Z",
"url": "https://files.pythonhosted.org/packages/55/71/39610cb39a0ea692daf330c4d83881eda4d92255593ea8428ba2c2258a60/gocardless_events-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ecba805a58a2aa58bce5a5aaa0b23862b554df2761c0665601095bb4713041a1",
"md5": "c0ecf3ad830a8cd5c71ba0ebb448ce1a",
"sha256": "03f961809b337eeca3ba01090734ccc08b55040049ba5c08bbc91b7fd92e6c64"
},
"downloads": -1,
"filename": "gocardless_events-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "c0ecf3ad830a8cd5c71ba0ebb448ce1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 15457,
"upload_time": "2024-12-30T17:15:52",
"upload_time_iso_8601": "2024-12-30T17:15:52.188466Z",
"url": "https://files.pythonhosted.org/packages/ec/ba/805a58a2aa58bce5a5aaa0b23862b554df2761c0665601095bb4713041a1/gocardless_events-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-30 17:15:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "karoo-ca",
"github_project": "gocardless-events",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gocardless-events"
}
