Next generation network of decentralized big data applications. Development follows the Aleph Whitepaper.
Albeit still incomplete as it is a work in progress, documentation
can be found at http://pyaleph.readthedocs.io/ or
built from this repository with $ python setup.py docs
We recommend following the Installing a Core Channel Node section of the documentation to install a node.
Do you want to contribute to the development of the CCN? Here is the procedure to install the development environment. We recommend using Ubuntu 20.04.
sudo apt install python3 python3-pip python3-venv build-essential libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev liblz4-dev libgmp-dev libsecp256k1-dev
Clone the repository and run the following commands from the root directory:
python3 -m virtualenv venv
source venv/bin/activate
pip install -e .[testing,docs]
You're ready to go!
We started to add Nix as an easy way to setup a development environment. This is still a work in progress and not all dependencies are covered yet.
To use it, you need to have Nix installed on your system. Then you can run:
nix-shell
This will provide you with a shell with PostgreSQL, Redis, and IPFS running.
To run test you can run:
nix-shell --run "pytest"
Or you can run the command in the nix shell:
nix-shell
# inside of nix shell
pytest
The Aleph CCN is written in Python and requires Python v3.8+. It will not work with older versions of Python.
It also relies on IPFS.
The Aleph CCN is open-source software, released under The MIT License (MIT).