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

Uploaded Source

Built Distribution

aleph_message-0.2.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.2.0.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for aleph-message-0.2.0.tar.gz
Algorithm Hash digest
SHA256 aaf62dbaed87513f71c77bf7dcd4116f18d0fd219b8ef800bdac9f807eee9b01
MD5 1258369dd24ee97f60a51547fb6e083d
BLAKE2b-256 79896d984293a82d4d7a523cb7f9a26ddfdecaab492804c116e8572ae5288774

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for aleph_message-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd43f80d85ce79f0ec891aadabe932e77a3276f325e59fe50aeee7f94586b715
MD5 4456968340373a3e74d96ae95665f82c
BLAKE2b-256 8832af47f1035800a883a88e23f18863521c16e7ffda27abade3ff9a353a6364

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