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

Uploaded Source

Built Distribution

aleph_message-0.1.16-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.16.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for aleph-message-0.1.16.tar.gz
Algorithm Hash digest
SHA256 b299c68ee7740486397c3424e5b425350582343becfda649519cf369be45e528
MD5 4d08a7f7ac9a1d9b0d72fab05762edfb
BLAKE2b-256 e5c42c0f09d1c3c560018ff62630e7265c7cb9c7a681c5f0c4184449aaaacd7b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.16-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for aleph_message-0.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 c752a1321eb2844775536ae6251e0158975ce0970a0a10d54b21c50ffb12516f
MD5 a1a12cd77bdd6df2d027968fd5608940
BLAKE2b-256 ccaea00ccb04a1fb19d6eae3b1973e89b043bd9fcbdb2a230aa9df67bac18b13

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