# Acqua
[](https://hub.docker.com)
[](https://github.com/aekasitt/acqua)
[](https://github.com/aekasitt/acqua)
[](https://github.com/aekasitt/acqua)
[](https://github.com/aekasitt/acqua)
[](https://github.com/aekasitt/acqua/blob/master/static/acqua-banner.svg)
## Getting started
You can use `acqua` simply by installing via `pip` on your Terminal.
```sh
pip install acqua
```
<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 `Testnet`
Sui Validator node with one-command.
```sh
acqua pull --mainnet
```
<details>
<summary> Sample output when running pull command </summary>
</details>
The initial pull 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 pull
process completes, you can begin deploying local network with middlewares as such:
```sh
acqua deploy --mainnet
```
Note: If you do not have `postgres:latest` image in your local Docker image registry, this may
take some time to deploy on your first run.
<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
Acqua not only facilitates the deployment of [Bitcoin](https://twentyone.world) services
such as the [Sui](https://sui.io) Validator node with a PoW relay, 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
acqua dashboard
```
<details>
<summary> Sample output when running dashboard command </summary>
</details>
## Contributions
### Prerequisites
* [python](https://www.python.org) version 3.9 and above
* [uv](https://docs.astral.sh/uv)
* [docker](https://www.docker.com)
### Set up local environment
The following guide walks through setting up your local working environment using `pyenv`
as Python version manager and `uv` as Python package manager. If you do not have `pyenv`
installed, run the following command.
<details>
<summary> Install using Homebrew (Darwin) </summary>
```sh
brew install pyenv --head
```
</details>
<details>
<summary> Install using standalone installer (Darwin and Linux) </summary>
```sh
curl https://pyenv.run | bash
```
</details>
If you do not have `uv` installed, run the following command.
<details>
<summary> Install using Homebrew (Darwin) </summary>
```sh
brew install uv
```
</details>
<details>
<summary> Install using standalone installer (Darwin and Linux) </summary>
```sh
curl -LsSf https://astral.sh/uv/install.sh | sh
```
</details>
Once you have `pyenv` Python version manager installed, you can
install any version of Python above version 3.8 for this project.
The following commands help you set up and activate a Python virtual
environment where `uv` can download project dependencies from the `PyPI`
open-sourced registry defined under `pyproject.toml` file.
<details>
<summary> Set up environment and synchronize project dependencies </summary>
```sh
pyenv shell 3.11.9
uv venv --python-preference system
source .venv/bin/activate
uv sync --dev
```
</details>
Now you have the entire project set-up and ready to be tinkered with. Try out the
standard `acqua` command which brings up a help menu.
<details>
<summary> Launch Acqua Help </summary>
```sh
$ acqua
> Usage: acqua [OPTIONS] COMMAND [ARGS]...
>
> acqua
>
> Options:
> --help Show this message and exit.
>
> Commands:
> auth Persist authentications in desired run-control file.
> build Build peripheral images for the desired cluster.
> clean Remove all active "acqua-*" containers, drop network.
> dashboard Dashboard for checking current state of images deployed.
> deploy Deploy cluster.
> pull Pull core and peripheral images from GitHub container registry
```
</details>
### 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": null,
"name": "acqua",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "anonymous, bitcoin, cli, lightning, terminal, tui, ui, user-interface",
"author": null,
"author_email": "Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>",
"download_url": "https://files.pythonhosted.org/packages/0a/2d/9d5ee35399c6271d33e921fdad70aaf14b973910eada62c6877732991ee2/acqua-0.1.4.tar.gz",
"platform": null,
"description": "# Acqua \n\n[](https://hub.docker.com)\n[](https://github.com/aekasitt/acqua)\n[](https://github.com/aekasitt/acqua)\n[](https://github.com/aekasitt/acqua)\n[](https://github.com/aekasitt/acqua)\n\n[](https://github.com/aekasitt/acqua/blob/master/static/acqua-banner.svg)\n\n## Getting started\n\nYou can use `acqua` simply by installing via `pip` on your Terminal.\n\n```sh\npip install acqua\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 `Testnet`\nSui Validator node with one-command.\n\n```sh\nacqua pull --mainnet\n```\n\n<details>\n <summary> Sample output when running pull command </summary>\n\n\n\n</details>\n\nThe initial pull 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 pull\nprocess completes, you can begin deploying local network with middlewares as such:\n\n```sh\nacqua deploy --mainnet\n```\n\nNote: If you do not have `postgres:latest` image in your local Docker image registry, this may\ntake some time to deploy on your first run.\n\n<details>\n<summary>Sample output when running deploy command</summary>\n\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\nAcqua not only facilitates the deployment of [Bitcoin](https://twentyone.world) services\nsuch as the [Sui](https://sui.io) Validator node with a PoW relay, but allows you to view\nNode'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\nacqua dashboard\n```\n\n<details>\n <summary> Sample output when running dashboard command </summary>\n\n\n</details>\n\n## Contributions\n\n### Prerequisites\n\n* [python](https://www.python.org) version 3.9 and above\n* [uv](https://docs.astral.sh/uv)\n* [docker](https://www.docker.com)\n\n### Set up local environment\n\nThe following guide walks through setting up your local working environment using `pyenv`\nas Python version manager and `uv` as Python package manager. If you do not have `pyenv`\ninstalled, run the following command.\n\n<details>\n <summary> Install using Homebrew (Darwin) </summary>\n \n ```sh\n brew install pyenv --head\n ```\n</details>\n\n<details>\n <summary> Install using standalone installer (Darwin and Linux) </summary>\n \n ```sh\n curl https://pyenv.run | bash\n ```\n</details>\n\nIf you do not have `uv` installed, run the following command.\n\n<details>\n <summary> Install using Homebrew (Darwin) </summary>\n\n ```sh\n brew install uv\n ```\n</details>\n\n<details>\n <summary> Install using standalone installer (Darwin and Linux) </summary>\n\n ```sh\n curl -LsSf https://astral.sh/uv/install.sh | sh\n ```\n</details>\n\n\nOnce you have `pyenv` Python version manager installed, you can\ninstall any version of Python above version 3.8 for this project.\nThe following commands help you set up and activate a Python virtual\nenvironment where `uv` can download project dependencies from the `PyPI`\nopen-sourced registry defined under `pyproject.toml` file.\n\n<details>\n <summary> Set up environment and synchronize project dependencies </summary>\n\n ```sh\n pyenv shell 3.11.9\n uv venv --python-preference system\n source .venv/bin/activate\n uv sync --dev\n ```\n</details>\n\nNow you have the entire project set-up and ready to be tinkered with. Try out the\nstandard `acqua` command which brings up a help menu.\n\n<details>\n <summary> Launch Acqua Help </summary>\n\n ```sh\n $ acqua\n > Usage: acqua [OPTIONS] COMMAND [ARGS]...\n > \n > acqua \n > \n > Options:\n > --help Show this message and exit.\n > \n > Commands:\n > auth Persist authentications in desired run-control file.\n > build Build peripheral images for the desired cluster.\n > clean Remove all active \"acqua-*\" containers, drop network.\n > dashboard Dashboard for checking current state of images deployed.\n > deploy Deploy cluster.\n > pull Pull core and peripheral images from GitHub container registry\n ```\n</details>\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": null,
"summary": null,
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"anonymous",
" bitcoin",
" cli",
" lightning",
" terminal",
" tui",
" ui",
" user-interface"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e2a424cc69e08db718e16a2e813861295d36320b1c6423f7390dc2f7b347746b",
"md5": "4ddc4a5c6b8436f87dd2b8a751b0e7dd",
"sha256": "0ddbcf96bdf998a1513cc2ed050a1862f200024ddb2c6225f1addd1f5c03435f"
},
"downloads": -1,
"filename": "acqua-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ddc4a5c6b8436f87dd2b8a751b0e7dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 29091,
"upload_time": "2024-11-08T18:23:15",
"upload_time_iso_8601": "2024-11-08T18:23:15.829999Z",
"url": "https://files.pythonhosted.org/packages/e2/a4/24cc69e08db718e16a2e813861295d36320b1c6423f7390dc2f7b347746b/acqua-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0a2d9d5ee35399c6271d33e921fdad70aaf14b973910eada62c6877732991ee2",
"md5": "b8a54b9053744ec8b00fe198b8851776",
"sha256": "ef881ec732f696ccd7a5835848c646375439c22871d0731d0ca12709d2000cd4"
},
"downloads": -1,
"filename": "acqua-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "b8a54b9053744ec8b00fe198b8851776",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7418277,
"upload_time": "2024-11-08T18:23:31",
"upload_time_iso_8601": "2024-11-08T18:23:31.615646Z",
"url": "https://files.pythonhosted.org/packages/0a/2d/9d5ee35399c6271d33e921fdad70aaf14b973910eada62c6877732991ee2/acqua-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 18:23:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "acqua"
}
JSON