Local Development Instructions
To install the ethstaker-deposit-cli
, follow these steps:
Prerequisites
Ensure you have the following software installed on your system:
- Git: Version control system to clone the repository. Download Git
- Python 3.9+: The programming language required to run the tool. Download Python
- pip: Package installer for Python, which is included with Python 3.9+.
Local Development Steps
-
Clone the Repository
git clone https://github.com/eth-educators/ethstaker-deposit-cli.git
-
Navigate to the Project Directory
cd ethstaker-deposit-cli
-
Setup virtualenv (optional)
Install
venv
if not already installed, e.g. for Debian/Ubuntu:sudo apt update && sudo apt install python3-venv
Create a new virtual environment:
python3 -m venv .venv source .venv/bin/activate
-
Install Dependencies
pip3 install -r requirements.txt
-
Run the CLI
You can now run the CLI tool using the following command:
python3 -m ethstaker_deposit [OPTIONS] COMMAND [ARGS]
-
Use pre-commit for PRs
Install
pre-commit
if not already installed, e.g. for Debian/Ubuntu:sudo apt update && sudo apt install pre-commit
Enable it for your
git commit
workflow:pre-commit install
To execute tests, you will need to install the test dependencies:
python3 -m pip install -r requirements_test.txt
python3 -m pytest tests