https://github.com/skellet0r/eth-stdlib

https://github.com/skellet0r/eth-stdlib

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/skellet0r/eth-stdlib
• Owner: skellet0r
• License: lgpl-3.0
• Created: 2022-09-06T03:19:22.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T23:58:42.000Z (5 months ago)
• Last Synced: 2024-10-04T16:12:28.017Z (about 2 months ago)
• Language: Python
• Size: 173 KB
• Stars: 13
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# The Ethereum Standard Library

[![GitHub](https://img.shields.io/github/license/skellet0r/eth-stdlib)](https://github.com/skellet0r/eth-stdlib/blob/master/COPYING)

[![Codecov](https://img.shields.io/codecov/c/github/skellet0r/eth-stdlib)](https://app.codecov.io/gh/skellet0r/eth-stdlib)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/skellet0r/eth-stdlib/test.yaml?label=test%20suite)](https://github.com/skellet0r/eth-stdlib/actions/workflows/test.yaml)

[![Read the Docs](https://img.shields.io/readthedocs/eth-stdlib)](https://eth-stdlib.readthedocs.io/en/latest/)

[![PyPI](https://img.shields.io/pypi/v/eth-stdlib)](https://pypi.org/project/eth-stdlib/)

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

## Installation

### Using pip

```bash

$ pip install eth-stdlib

```

### Using poetry

```bash

$ poetry add eth-stdlib

```

## Development

### Initializing an Environment

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

1. Install [poetry](https://python-poetry.org/)

   ```bash

   $ pipx install poetry

   ```

2. Clone the eth-stdlib repository

   ```bash

   $ git clone https://github.com/skellet0r/eth-stdlib.git

   ```

3. Initialize virtual environment

   ```bash

   $ poetry install --sync

   ```

Afterwards the development environment will be complete.

### Testing

To run the test suite, execute the following command:

```bash

$ 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).