py-geth
Python wrapper around running geth as a subprocess
System Dependency
This library requires the geth executable to be present.
If managing your own bundled version of geth, set the path to the binary using the
GETH_BINARYenvironment variable.
Installation
python -m pip install py-geth
Quickstart
To run geth connected to the mainnet
>>> from geth import MainnetGethProcess
>>> geth = MainnetGethProcess()
>>> geth.start()
Or in dev mode for testing. These require you to give them a name.
>>> from geth import DevGethProcess
>>> geth = DevGethProcess('testing')
>>> geth.start()
By default the DevGethProcess sets up test chains in the default datadir
used by geth. If you would like to change the location for these test
chains, you can specify an alternative base_dir.
>>> geth = DevGethProcess('testing', '/tmp/some-other-base-dir/')
>>> geth.start()
Each instance has a few convenient properties.
>>> geth.data_dir
"~/.ethereum"
>>> geth.rpc_port
8545
>>> geth.ipc_path
"~/.ethereum/geth.ipc"
>>> geth.accounts
['0xd3cda913deb6f67967b99d67acdfa1712c293601']
>>> geth.is_alive
False
>>> geth.is_running
False
>>> geth.is_stopped
False
>>> geth.start()
>>> geth.is_alive
True # indicates that the subprocess hasn't exited
>>> geth.is_running
True # indicates that `start()` has been called (but `stop()` hasn't)
>>> geth.is_stopped
False
>>> geth.stop()
>>> geth.is_alive
False
>>> geth.is_running
False
>>> geth.is_stopped
True
>>> geth.version
"1.17.2-stable"
When testing it can be nice to see the logging output produced by the geth
process. py-geth provides a mixin class that can be used to log the stdout
and stderr output to a logfile.
>>> from geth import LoggingMixin, DevGethProcess
>>> class MyGeth(LoggingMixin, DevGethProcess):
... pass
>>> geth = MyGeth()
>>> geth.start()
All logs will be written to logfiles in ./logs/ in the current directory.
The underlying geth process can take additional time to open the RPC or IPC
connections. You can use the following interfaces to query whether these are ready.
>>> geth.wait_for_rpc(timeout=30) # wait up to 30 seconds for the RPC connection to open
>>> geth.is_rpc_ready
True
>>> geth.wait_for_ipc(timeout=30) # wait up to 30 seconds for the IPC socket to open
>>> geth.is_ipc_ready
True
Installing specific versions of geth
This feature is experimental, best-effort, and subject to breaking changes. Historical tags may become incompatible with current Go toolchains. Prefer geth's official downloads or another supported installation method for normal use.
Versions of geth dating back to v1.14.0 can be installed using py-geth.
See install.py for
the current list of supported versions.
Installation can be done via the command line:
$ python -m geth.install v1.17.2
Or from python using the install_geth function.
>>> from geth import install_geth
>>> install_geth('v1.17.2')
The installed binary can be found in the $HOME/.py-geth directory, under your
home directory. The v1.17.2 binary would be located at
$HOME/.py-geth/geth-v1.17.2/bin/geth.
The test suite includes a real source-installation test that clones and builds geth in a pytest temporary directory:
uv run --group test pytest tests/installation/test_geth_installation.py
About DevGethProcess
The DevGethProcess will run geth in --dev mode and is designed to facilitate testing.
In that regard, it is preconfigured as follows.
- A single account is created, allocated 1 billion ether, and assigned as the coinbase.
- All APIs are enabled on both
rpcandipcinterfaces. - Networking is configured to not look for or connect to any peers.
- A
networkidis not set as one can no longer be set along with--dev. - Verbosity is set to
5(DEBUG) - The RPC interface tries to bind to 8545 but will find an open port if this port is not available.
- The DevP2P interface tries to bind to 30303 but will find an open port if this port is not available.
Development
Clone the repository:
$ git clone git@github.com:ApeWorX/py-geth.git
Next, run the following from the newly-created py-geth directory:
$ uv sync
Running the tests
You can run the tests with:
pytest tests
Developer Setup
If you would like to hack on py-geth, please check out the Snake Charmers Tactical Manual for information on how we do:
- Testing
- Pull Requests
- Documentation
We use prek to maintain consistent code style. Once
installed, it will run automatically with every commit. You can also run it manually
with uv run prek run --all-files. If you need to make a commit that skips the prek checks, you
can do so with git commit --no-verify.
Development Environment Setup
You can set up your dev environment with the dev dependency group, which is
installed by default when you run uv sync.
git clone git@github.com:ApeWorX/py-geth.git
cd py-geth
uv sync
uv run prek install
Release setup
Releases are published from GitHub Releases. The release tag is the canonical
version source, setuptools-scm derives the package version from that tag, and
the release workflow publishes to PyPI through trusted publishing.
Adding Support For New Geth Versions
There is an automation script to facilitate adding support for new geth versions: update_geth.py
To add support for a geth version, run the following line from the py-geth directory, substituting
the version for the one you wish to add support for. Note that the v in the versioning is
optional.
$ python update_geth.py v1_16_0
To introduce support for more than one version, pass in the versions in increasing order, ending with the latest version.
$ python update_geth.py v1_16_1 v1_16_2 v1_16_3
Always review your changes before committing as something may cause this existing pattern to change at some point. It is best to compare the git difference with a previous commit that introduced support for a new geth version to make sure everything looks good.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file py_geth-7.0.1.tar.gz.
File metadata
- Download URL: py_geth-7.0.1.tar.gz
- Upload date:
- Size: 44.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
732ea55f1e0a4cd8a0ff0037891926a93094f2b067a3079706470b17dd831cdc
|
|
| MD5 |
fbecf939b0536bbf05a1f7d947c406d3
|
|
| BLAKE2b-256 |
6b7a6d8ecf4a6a1f16e9b8bba9fb44b8cef5bcbc6b4adfc86c1b4e37be59aa6a
|
Provenance
The following attestation bundles were made for py_geth-7.0.1.tar.gz:
Publisher:
publish.yaml on ApeWorX/py-geth
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
py_geth-7.0.1.tar.gz -
Subject digest:
732ea55f1e0a4cd8a0ff0037891926a93094f2b067a3079706470b17dd831cdc - Sigstore transparency entry: 2627023805
- Sigstore integration time:
-
Permalink:
ApeWorX/py-geth@38e37af326a8c921380d6270e9b391c3b0f65747 -
Branch / Tag:
refs/tags/v7.0.1 - Owner: https://github.com/ApeWorX
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@38e37af326a8c921380d6270e9b391c3b0f65747 -
Trigger Event:
release
-
Statement type:
File details
Details for the file py_geth-7.0.1-py3-none-any.whl.
File metadata
- Download URL: py_geth-7.0.1-py3-none-any.whl
- Upload date:
- Size: 29.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c9143910b7b6186814349e994c22e38e65895b20032e2a3691322e83f920ac80
|
|
| MD5 |
018e83fe610d249b334529fadc02dff3
|
|
| BLAKE2b-256 |
ef646b79b0b405c6df10a73eb87054d7abf6fee1a6d1016c7ed54efe57f4f1ae
|
Provenance
The following attestation bundles were made for py_geth-7.0.1-py3-none-any.whl:
Publisher:
publish.yaml on ApeWorX/py-geth
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
py_geth-7.0.1-py3-none-any.whl -
Subject digest:
c9143910b7b6186814349e994c22e38e65895b20032e2a3691322e83f920ac80 - Sigstore transparency entry: 2627023807
- Sigstore integration time:
-
Permalink:
ApeWorX/py-geth@38e37af326a8c921380d6270e9b391c3b0f65747 -
Branch / Tag:
refs/tags/v7.0.1 - Owner: https://github.com/ApeWorX
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@38e37af326a8c921380d6270e9b391c3b0f65747 -
Trigger Event:
release
-
Statement type:
