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

Uploaded Source

Built Distribution

aleph_message-0.1.8-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.8.tar.gz
  • Upload date:
  • Size: 5.9 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.8.tar.gz
Algorithm Hash digest
SHA256 d22bb381e17c946f9db0bbebd800e6840f798acd177bed828e6171a7e2ccbb3a
MD5 b23c11e759efb09115963776eddcbd82
BLAKE2b-256 b9cb3aa471cb85e43d5dc40cc772c5793ff4436c1445135740a1afdf0c4bcb81

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 6.6 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a1436ef8ce19e9cb7ede4514a325ec6e188a21bee2c0495a02b588687d064a34
MD5 9b5c72529f361993438bff2da8ac4bdf
BLAKE2b-256 9d6f360edc05f81cdee3f374c030901738cebdf9127e572a4c22c89ab6e3ec61

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