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.1.15.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

aleph_message-0.1.15-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.15.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for aleph-message-0.1.15.tar.gz
Algorithm Hash digest
SHA256 6fb5cc8c9bc43c756316afefbf5e430963aa2b4218f7ff34414c0d16561d2668
MD5 0b5c6e67237199f4e85bd5143f08ce99
BLAKE2b-256 0967269df6bdbf077f5320bf4266ffdde486d9a73a34b0c648ce40a6f95be6ca

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.15-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for aleph_message-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 351aeb1b034f738ddf150d7b04f21d131657b364f9d06427204f1314370883bc
MD5 b2a90fbfe66d61cbac529595b5ce9ca7
BLAKE2b-256 a27848ee9f76556177bbbfa98e15bfe4b977040f92ef0b67c742412c59b611b8

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