/eth-stdlib

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

The Ethereum Standard Library

GitHub Codecov GitHub Workflow Status Read the Docs PyPI

The Ethereum Standard Library is a collection of libraries for developers building on the EVM.

Installation

Using pip

$ pip install eth-stdlib

Using poetry

$ poetry add eth-stdlib

Development

Initializing an Environment

To start developing/contributing to the eth-stdlib code base follow these steps:

  1. Install poetry

    $ pipx install poetry
  2. Clone the eth-stdlib repository

    $ git clone https://github.com/skellet0r/eth-stdlib.git
  3. Initialize virtual environment

    $ poetry install --sync

Afterwards the development environment will be complete.

Testing

To run the test suite, execute the following command:

$ poetry run pytest

After running the test suite, code coverage results will be displayed in the terminal, as well as exported in html format (in the htmlcov directory).