Metadata-Version: 2.1
Name: aleph-message
Version: 0.2.3
Summary: Aleph.im message specification 
Home-page: https://github.com/aleph-im/aleph-message
Author: Hugo Herter
Author-email: git@hugoherter.com
License: MIT
Keywords: aleph.im message validation specification
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Distributed Computing
Description-Content-Type: text/markdown
License-File: LICENSE

# 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](https://pydantic-docs.helpmanual.io/) 
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](https://github.com/aleph-im/aleph-client).

## Usage

```python
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())
```


