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

Uploaded Source

Built Distribution

aleph_message-0.1.11-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.11.tar.gz
  • Upload date:
  • Size: 6.2 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.11.tar.gz
Algorithm Hash digest
SHA256 5352965eef97798875f2dd2020c8035d24731dc4dcbec1cebce7862ed2d4c12d
MD5 d612d13038e7e031b284b577afb814dc
BLAKE2b-256 c08076e3d5a7254200887e8e539bf30384ebfc9d1d11daabf55481110e235ef2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 6.9 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 0c9081f5cd40366992d1038bfe0e307ab4e080377d91a830dd6f66491f205ac1
MD5 47fea60878b8b67308de4057e80964e7
BLAKE2b-256 103b9818e0ad1cbba4e39e1f7b1f5f0333a2e51df40c2fa4c0919d2be92a9b6f

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