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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-message-0.1.17.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.17.tar.gz
Algorithm Hash digest
SHA256 f499a0b96889af6652ed979f6b83e12860dde841ace377994bca767895b893bd
MD5 1cf9e5197119e4717ddbe934c4fe0c6e
BLAKE2b-256 2c31e4958a2dec5b566d9cde7e29d8687a9dae2493aa066b84f99cb7d6e04c91

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aleph_message-0.1.17-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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 a7ff43ba539c494097473406c186325b879254f1828854994cf8a2502e5f4ad3
MD5 438f14f2754f5642c80b5e139944bab7
BLAKE2b-256 75259ce84b7059612ec7d7afc708d5488b9ba9e608d3e0cedbbf9ceee5cd1b04

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