# Arise
[](https://twentyone.world)
[](https://hub.docker.com)
[](https://github.com/krutt/arise)
[](https://github.com/krutt/arise)
[](https://github.com/krutt/arise)
[](https://github.com/krutt/arise)
[](https://github.com/krutt/arise/blob/master/static/arise-banner.svg)
## Prerequisites
* python (3.8+)
* pip
* docker
## Getting started
You can use `arise` simply by installing via `pip` on your Terminal.
```sh
pip install arise
```
<details>
<summary>Sample output when running install command</summary>
</details>
And build required images with `build` command. The following shows you how to build a `Testnet4`
Bitcoin-Core node as well as [electrs](https://github.com/aekasitt/electrs),
[mempool](https://github.com/mempool/mempool) and [mutiny-web](https://github.com/MutinyWallet/mutiny-web)
```sh
arise build --testnet4 --electrs --mempool --mutiny-web
```
<details>
<summary>Sample output when running build command</summary>
</details>
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:
```sh
arise deploy --testnet4 --with-electrs --with-mempool --with-mutiny-web
```
<details>
<summary>Sample output when running deploy command</summary>
</details>
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](https://twentyone.world) 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.
```sh
arise dashboard
```
<details>
<summary>Sample output when running dashboard command</summary>
</details>
## Contributions
To be determined
## Attributions
1. [ปฐวี - Patavi](https://www.f0nt.com/release/sov-patavi) font by [uvSOV - Worawut Thanawatanawanich](fb.com/worawut.thanawatanawanich)
2. [Florent Galon](https://flo.rent) for flame animation used as Tusk's HellFire.
3. [Avinash Vytla](https://github.com/SnippetsDevelop) for breaking down Florent's process on [YouTube](https://youtu.be/RP_x_F7m1UI)
### Known issues
You may run into this setback when first running this project. This is a
[docker-py](https://github.com/docker/docker-py/issues/3059) issue widely known as of October 2022.
```python
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](https://github.com/docker/docker-py/issues/3059#issuecomment-1294369344)
Recommended fix is to run the following command:
```sh
sudo ln -s "$HOME/.docker/run/docker.sock" /var/run/docker.sock
```
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/krutt/arise",
"name": "arise",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "anonymous, bitcoin, cli, lightning, terminal, tui, ui, user-interface",
"author": "Sitt Guruvanich",
"author_email": "aekasitt.g+github@siamintech.co.th",
"download_url": "https://files.pythonhosted.org/packages/e8/df/bdde95f523fbf8a94e4d8d178ea6f0d26bf2bb00ec6214f66e353479c3b7/arise-0.2.1.tar.gz",
"platform": null,
"description": "# Arise\n\n[](https://twentyone.world)\n[](https://hub.docker.com)\n[](https://github.com/krutt/arise)\n[](https://github.com/krutt/arise)\n[](https://github.com/krutt/arise)\n[](https://github.com/krutt/arise)\n\n[](https://github.com/krutt/arise/blob/master/static/arise-banner.svg)\n\n## Prerequisites\n\n* python (3.8+)\n* pip\n* docker\n\n## Getting started\n\nYou can use `arise` simply by installing via `pip` on your Terminal.\n\n```sh\npip install arise\n```\n<details>\n<summary>Sample output when running install command</summary>\n\n\n\n</details>\n\nAnd build required images with `build` command. The following shows you how to build a `Testnet4`\nBitcoin-Core node as well as [electrs](https://github.com/aekasitt/electrs),\n[mempool](https://github.com/mempool/mempool) and [mutiny-web](https://github.com/MutinyWallet/mutiny-web)\n\n```sh\narise build --testnet4 --electrs --mempool --mutiny-web\n```\n\n<details>\n<summary>Sample output when running build command</summary>\n\n\n\n</details>\n\nThe initial build may take some time as it is downloading source codes from different repositories\nand interfacing with `Docker Daemon` to build according to flagged requirements. Once the build process\ncompletes, you can begin deploying local network with peripherals as such:\n\n```sh\narise deploy --testnet4 --with-electrs --with-mempool --with-mutiny-web\n```\n\n<details>\n<summary>Sample output when running deploy command</summary>\n\n\n\n</details>\n\nYou will have docker containers running in the backend, ready to be interfaced by your local\nenvironment applications you are developing.\n\n## Dashboard\n\nArise not only facilitates the deployment of intermingling [Bitcoin](https://twentyone.world) services\nbut allows you to view Node's Blockchain Information, Mempool Information, Peripheral Details and etc.\n\nIn order to view relevant metrics, launch the dashboard using the following command.\n\n```sh\narise dashboard\n```\n\n<details>\n<summary>Sample output when running dashboard command</summary>\n\n\n\n</details>\n\n## Contributions\n\nTo be determined\n\n## Attributions\n\n1. [\u0e1b\u0e10\u0e27\u0e35 - Patavi](https://www.f0nt.com/release/sov-patavi) font by [uvSOV - Worawut Thanawatanawanich](fb.com/worawut.thanawatanawanich)\n2. [Florent Galon](https://flo.rent) for flame animation used as Tusk's HellFire.\n3. [Avinash Vytla](https://github.com/SnippetsDevelop) for breaking down Florent's process on [YouTube](https://youtu.be/RP_x_F7m1UI)\n\n### Known issues\n\nYou may run into this setback when first running this project. This is a\n[docker-py](https://github.com/docker/docker-py/issues/3059) issue widely known as of October 2022.\n\n```python\ndocker.errors.DockerException:\n Error while fetching server API version: (\n 'Connection aborted.', FileNotFoundError(\n 2, 'No such file or directory'\n )\n )\n```\n\nSee the following issue for Mac OSX troubleshooting.\n[docker from_env and pull is broken on mac](https://github.com/docker/docker-py/issues/3059#issuecomment-1294369344)\nRecommended fix is to run the following command:\n\n```sh\nsudo ln -s \"$HOME/.docker/run/docker.sock\" /var/run/docker.sock\n```\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Running Bitcoin and peripherals via Terminal User Interface",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/krutt/arise",
"Repository": "https://github.com/krutt/arise"
},
"split_keywords": [
"anonymous",
" bitcoin",
" cli",
" lightning",
" terminal",
" tui",
" ui",
" user-interface"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f41c9c4fdf674fdd52bb0c7abd26b18f4d31fda4a5307edf8eeb0ef7ecac808b",
"md5": "08bea2da878b1a7d988d15168bda905a",
"sha256": "7fb350439f0417111e4a2caa138d169838663ccd19bee2b149da02bb3a1e7cef"
},
"downloads": -1,
"filename": "arise-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08bea2da878b1a7d988d15168bda905a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 25209,
"upload_time": "2024-09-12T08:34:41",
"upload_time_iso_8601": "2024-09-12T08:34:41.784311Z",
"url": "https://files.pythonhosted.org/packages/f4/1c/9c4fdf674fdd52bb0c7abd26b18f4d31fda4a5307edf8eeb0ef7ecac808b/arise-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8dfbdde95f523fbf8a94e4d8d178ea6f0d26bf2bb00ec6214f66e353479c3b7",
"md5": "788818563eaf6adf9591ba935d637a27",
"sha256": "0814bd55b2356710dfedb16d022df3e42f964a1fe7c2100acb9706163a07f842"
},
"downloads": -1,
"filename": "arise-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "788818563eaf6adf9591ba935d637a27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 17440,
"upload_time": "2024-09-12T08:34:43",
"upload_time_iso_8601": "2024-09-12T08:34:43.752558Z",
"url": "https://files.pythonhosted.org/packages/e8/df/bdde95f523fbf8a94e4d8d178ea6f0d26bf2bb00ec6214f66e353479c3b7/arise-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 08:34:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "krutt",
"github_project": "arise",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "arise"
}
JSON
