Pydantic models for GitLab webhook payloads

Navigation

Verified details

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

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Rich Wareham
  • Requires: Python <4.0, >=3.10
Classifiers
Report project as malware

Project description

Pydantic models for GitLab Webhooks

PyPI - Version PyPI - Python Version GitHub Release Test suite status

Module containing Pydantic models for validating bodies from GitLab webhook requests.

Documentation

The project documentation including an API reference can be found at https://rjw57.github.io/pydantic-gitlab-webhooks/.

Usage example

Intended usage is via a single validate_event_header_and_body function which will validate an incoming webhook's X-Gitlab-Event header and the body after being parsed into a Python dict.

from pydantic import ValidationError
from pydantic_gitlab_webhooks import (
    validate_event_body_dict,
    validate_event_header_and_body_dict,
)

event_body = {
    "object_kind": "access_token",
    "group": {
        "group_name": "Twitter",
        "group_path": "twitter",
        "group_id": 35,
        "full_path": "twitter"
    },
    "object_attributes": {
        "user_id": 90,
        "created_at": "2024-01-24 16:27:40 UTC",
        "id": 25,
        "name": "acd",
        "expires_at": "2024-01-26"
    },
    "event_name": "expiring_access_token"
}

# Use the value of the "X-Gitlab-Event" header and event body to validate
# the incoming event.
parsed_event = validate_event_header_and_body_dict(
    "Resource Access Token Hook",
    event_body
)
assert parsed_event.group.full_path == "twitter"

# Invalid event bodies or hook headers raise Pydantic validation errors
try:
    validate_event_header_and_body_dict("invalid hook", event_body)
except ValidationError:
    pass  # ok - expected error raised
else:
    assert False, "ValidationError was not raised"

# Event bodies can be parsed without the header hook if necessary although using
# the hook header is more efficient.
parsed_event = validate_event_body_dict(event_body)
assert parsed_event.group.full_path == "twitter"

# Event models may be imported individually. For example:
from pydantic_gitlab_webhooks.events import GroupAccessTokenEvent

parsed_event = GroupAccessTokenEvent.model_validate(event_body)

Project details

Verified details

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

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Rich Wareham
  • Requires: Python <4.0, >=3.10
Classifiers

Release history Release notifications | RSS feed

This version

0.3.51

0.3.50

0.3.49

0.3.48

0.3.47

0.3.46

0.3.45

0.3.44

0.3.43

0.3.42

0.3.41

0.3.40

0.3.39

0.3.38

0.3.37

0.3.36

0.3.35

0.3.34

0.3.33

0.3.32

0.3.31

0.3.30

0.3.29

0.3.28

0.3.27

0.3.26

0.3.25

0.3.24

0.3.23

0.3.22

0.3.21

0.3.20

0.3.19

0.3.18

0.3.17

0.3.16

0.3.15

0.3.14

0.3.13

0.3.12

0.3.11

0.3.10

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.3

0.2.2

0.2.1

0.2.0

0.1.15

0.1.14

0.1.13

0.1.7

0.1.6

0.1.5

0.1.2

0.1.1

Download files

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

Source Distribution

pydantic_gitlab_webhooks-0.3.51.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

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

pydantic_gitlab_webhooks-0.3.51-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_gitlab_webhooks-0.3.51.tar.gz.

File metadata

File hashes

Hashes for pydantic_gitlab_webhooks-0.3.51.tar.gz
Algorithm Hash digest
SHA256 7efae6bae62cb4023660ac24c51e7878c1203129a32ee3c7b9a2e3c23f1cd97c
MD5 79b61298ee469a1b48a0733c181753cf
BLAKE2b-256 a84f4d55fda94dfbfb4ad43d4563ea0fee56d61fa51824e5d23316b6590ecff8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_gitlab_webhooks-0.3.51.tar.gz:

Publisher: main.yml on rjw57/pydantic-gitlab-webhooks

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

File details

Details for the file pydantic_gitlab_webhooks-0.3.51-py3-none-any.whl.

File metadata

File hashes

Hashes for pydantic_gitlab_webhooks-0.3.51-py3-none-any.whl
Algorithm Hash digest
SHA256 5d4ad46b724d935dea385ce474c0144a5d562758abd3fcf89f6a58b2cd894165
MD5 fd7afd8c875965213acddc21bc1a318a
BLAKE2b-256 3bbc2024c41b6106e146305eafc575972f8006e3affda2bc9dd3ebaf64a9f9ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_gitlab_webhooks-0.3.51-py3-none-any.whl:

Publisher: main.yml on rjw57/pydantic-gitlab-webhooks

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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page