arise 0.2.0

Description:

arise 0.2.0

Arise







Prerequisites

python (3.8+)
pip
docker

Getting started
You can use arise simply by installing via pip on your Terminal.
pip install arise


Sample output when running install command


And build required images with build command. The following shows you how to build a Testnet4
Bitcoin-Core node as well as electrs,
mempool and mutiny-web
arise build --testnet4 --electrs --mempool --mutiny-web


Sample output when running build command


The initial build may take some time as it is downloading source codes from different repositories
and interfacing with Docker Daemon to build according to flagged requirements. Once the build process
completes, you can begin deploying local network with peripherals as such:
arise deploy --testnet4 --with-electrs --with-mempool --with-mutiny-web


Sample output when running deploy command


You will have docker containers running in the backend, ready to be interfaced by your local
environment applications you are developing.
Dashboard
Arise not only facilitates the deployment of intermingling Bitcoin services
but allows you to view Node's Blockchain Information, Mempool Information, Peripheral Details and etc.
In order to view relevant metrics, launch the dashboard using the following command.
arise dashboard


Sample output when running dashboard command


Contributions
To be determined
Known issues
You may run into this setback when first running this project. This is a
docker-py issue widely known as of October 2022.
docker.errors.DockerException:
Error while fetching server API version: (
'Connection aborted.', FileNotFoundError(
2, 'No such file or directory'
)
)

See the following issue for Mac OSX troubleshooting.
docker from_env and pull is broken on mac
Recommended fix is to run the following command:
sudo ln -s "$HOME/.docker/run/docker.sock" /var/run/docker.sock

License
This project is licensed under the terms of the MIT license.