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

Uploaded Source

Built Distribution

aleph_message-0.1.9-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.9.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for aleph-message-0.1.9.tar.gz
Algorithm Hash digest
SHA256 d393f9c5a52a13f9fcdfb09a54ade43adedd75d7b423cdf72ebc195fa041cd77
MD5 2b973cd42590302ad15d811f621c633e
BLAKE2b-256 d365ece9fa928722ae3f6d39d0d57d065cf47ff6306e9d6a5f07c77beec89c2e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for aleph_message-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 23f1f283cc4510401bec80123bd0b710da6e9890a3afd3f3b2f0c253d857d22e
MD5 64f5918c1b975197a75b252fd583c0f8
BLAKE2b-256 7ebc836e2786186b6b1c1163efa924c6fc3a5d43dc559143f3fb59d72b4e3d05

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