Skip to main content

Aleph.im message specification

Project description

Aleph.im Message Specification

This library aims to provide an easy way to create, update and validate messages from Aleph.im.

It mainly consists in pydantic models that provide field type validation and IDE autocompletion for messages.

Status

Currently, only basic type validation is included. Advanced data and signature validation is not included.

In the future, this library would be useful within other projects such as the client library aleph-client.

Usage

import requests
from aleph_message import Message
from pydantic import ValidationError

message_dict = requests.get(ALEPH_API_SERVER + "/api/v0/messages.json?hashes=...").json()

try:
    message = Message(**message_dict)
    print(message.sender)
except ValidationError as e:
    print(e.json())

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

aleph-message-0.3.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

aleph_message-0.3.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file aleph-message-0.3.0.tar.gz.

File metadata

  • Download URL: aleph-message-0.3.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for aleph-message-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f1dafd2a1ecb143810b38ddf7e0b630b24d2d50dd8df3cbca349bc4940102927
MD5 de50ebc0de5c7b21405730cf6ff70942
BLAKE2b-256 8bc231aeaa0a92166ba9fe88a370938531178fd33ca991a958d1f3c273ee9305

See more details on using hashes here.

Provenance

File details

Details for the file aleph_message-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aleph_message-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03448786e12f94a4f2b6003fa805b0e164eb284c940e773806a4c93b5d68bfa9
MD5 6bb18c86907d71fa5bae3875e35cc21e
BLAKE2b-256 8f4b523bd963de066ae5f22307e6d7cbc3c0fa0b6c551aae241db11948028b01

See more details on using hashes here.

Provenance

Supported by

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