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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.7.tar.gz
  • Upload date:
  • Size: 5.8 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.0 CPython/3.9.5

File hashes

Hashes for aleph-message-0.1.7.tar.gz
Algorithm Hash digest
SHA256 cf54aae4a522e7e9b55b05bf438ecdceb0a9d22b9751ca9b8bf05c4f5ac3bbc6
MD5 301f3c20cba56a9326e39d2e6bc017b3
BLAKE2b-256 914b138ee54fb5db9da217fd5ae182008090ab5468c74c7cdc7c8194d814a382

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.7-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.0 CPython/3.9.5

File hashes

Hashes for aleph_message-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ccfc56031d98dc7106556bf0baa41d309a7ff04cc02ace6d0edd440d1c0888bb
MD5 d09665bc565137343008283853eb04cd
BLAKE2b-256 5ac282809f3d8b1718ae58f497b9285560170065371e48793ddfa7a67321bcec

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