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

Uploaded Source

Built Distribution

aleph_message-0.1.3-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aleph-message-0.1.3.tar.gz
Algorithm Hash digest
SHA256 365c1a6be8556cf90ebbe4ef043daa727090da3f8da9ab66652898b863b73231
MD5 23b5a72b8f3b620a0e3ec2f292ac5318
BLAKE2b-256 9a7dc6d9d14d1bfdaae1158db90cbc3ab23ccd3d0d0a1758df06500bd721ebff

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for aleph_message-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d13ce4e63ed99bf0e0e42b596cbcfdbed71afd6aa44f3f58671d5f4c70b67f70
MD5 ca905474c15eeb943da67ec8d6eaed68
BLAKE2b-256 fb97226c5299e1c6fd97e8af4d5b8c59799b4f2086f2170afc669e175b92381f

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