Cleanup project metadata

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Aleph.im project
+Copyright (c) 2019-2023 Aleph.im
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,45 @@
+
+# aleph-sdk-python
+Python SDK for the Aleph.im network, next generation network of decentralized big data applications.
+
+Development follows the [Aleph Whitepaper](https://github.com/aleph-im/aleph-whitepaper).
+
+## Documentation
+Documentation (albeit still vastly incomplete as it is a work in progress) can be found at [http://aleph-client.readthedocs.io/](http://aleph-client.readthedocs.io/) or built from this repo with:
+
+```shell
+$ python setup.py docs
+```
+
+## Requirements
+### Linux 
+Some cryptographic functionalities use curve secp256k1 and require installing [libsecp256k1](https://github.com/bitcoin-core/secp256k1).
+
+```shell
+$ apt-get install -y python3-pip libsecp256k1-dev
+```
+Using some chains may also require installing `libgmp3-dev`.
+
+### macOs 
+```shell
+$ brew tap cuber/homebrew-libsecp256k1
+$ brew install libsecp256k1
+```
+
+## Installation
+Using pip and [PyPI](https://pypi.org/project/aleph-sdk-python/):
+
+```shell
+$ pip install aleph-sdk-python[ethereum,solana,tezos]
+```
+
+## Installation for development
+To install from source and still be able to modify the source code:
+
+```shell
+$ pip install -e .[testing]
+```
+or 
+```shell
+$ python setup.py develop
+```

docker/python-3.10.dockerfile

@@ -20,7 +20,7 @@ RUN pip install --upgrade pip wheel twine
 
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
-RUN pip install --upgrade 'aleph-message~=0.2.3' eth_account pynacl base58
+RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
 RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
 
 WORKDIR /opt/aleph-client/
@@ -36,6 +36,3 @@ ENV ALEPH_PRIVATE_KEY_FILE=/data/secret.key
 
 WORKDIR /home/user
 USER user
-RUN aleph --install-completion bash
-ENTRYPOINT ["aleph"]
-CMD ["--help"]

docker/python-3.11.dockerfile

@@ -20,7 +20,7 @@ RUN pip install --upgrade pip wheel twine
 
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
-RUN pip install --upgrade 'aleph-message~=0.2.3' eth_account pynacl base58
+RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
 RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
 
 WORKDIR /opt/aleph-client/
@@ -36,6 +36,3 @@ ENV ALEPH_PRIVATE_KEY_FILE=/data/secret.key
 
 WORKDIR /home/user
 USER user
-RUN aleph --install-completion bash
-ENTRYPOINT ["aleph"]
-CMD ["--help"]

docker/python-3.9.dockerfile

@@ -20,7 +20,7 @@ RUN pip install --upgrade pip wheel twine
 
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
-RUN pip install --upgrade 'aleph-message~=0.2.3' eth_account pynacl base58
+RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
 RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
 
 WORKDIR /opt/aleph-client/
@@ -36,6 +36,3 @@ ENV ALEPH_PRIVATE_KEY_FILE=/data/secret.key
 
 WORKDIR /home/user
 USER user
-RUN aleph --install-completion bash
-ENTRYPOINT ["aleph"]
-CMD ["--help"]

docker/ubuntu-20.04.dockerfile

@@ -25,7 +25,7 @@ RUN pip install --upgrade pip wheel twine
 
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
-RUN pip install --upgrade 'aleph-message~=0.2.3' eth_account pynacl base58
+RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
 RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
 
 WORKDIR /opt/aleph-client/
@@ -42,6 +42,3 @@ ENV ALEPH_PRIVATE_KEY_FILE=/data/secret.key
 
 WORKDIR /home/user
 USER user
-RUN aleph --install-completion bash
-ENTRYPOINT ["aleph"]
-CMD ["--help"]

docker/ubuntu-22.04.dockerfile

@@ -25,7 +25,7 @@ RUN pip install --upgrade pip wheel twine
 
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
-RUN pip install --upgrade 'aleph-message~=0.2.3' eth_account pynacl base58
+RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
 RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
 
 WORKDIR /opt/aleph-client/
@@ -42,6 +42,3 @@ ENV ALEPH_PRIVATE_KEY_FILE=/data/secret.key
 
 WORKDIR /home/user
 USER user
-RUN aleph --install-completion bash
-ENTRYPOINT ["aleph"]
-CMD ["--help"]

docker/with-ipfs.dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9
+FROM python:3.10
 
 # === Install IPFS ===
 RUN apt-get install -y wget

setup.cfg

@@ -36,7 +36,7 @@ install_requires =
     eciespy
     typing_extensions
     typer
-    aleph-message~=0.2.3
+    aleph-message~=0.3.0
     eth_account>=0.4.0
     python-magic
 # The usage of test_requires is discouraged, see `Dependency Management` docs