https://github.com/holgern/pymempool

About Python Package for Mempool.Space API.
https://github.com/holgern/pymempool

api api-wrapper bitcoin mempool python rest-api wrapper

Last synced: about 1 month ago
JSON representation

About Python Package for Mempool.Space API.

• Host: GitHub
• URL: https://github.com/holgern/pymempool
• Owner: holgern
• License: mit
• Created: 2022-06-03T12:48:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-21T07:42:08.000Z (9 months ago)
• Last Synced: 2024-10-12T09:17:09.189Z (3 months ago)
• Topics: api, api-wrapper, bitcoin, mempool, python, rest-api, wrapper
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 14
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mempool.space API wrapper

[![codecov](https://codecov.io/gh/holgern/pymempool/graph/badge.svg?token=VyIU0ZxwpD)](https://codecov.io/gh/holgern/pymempool)

[![PyPi Version](https://img.shields.io/pypi/v/pymempool.svg)](https://pypi.python.org/pypi/pymempool/)

Python3 wrapper around the [mempool.space](https://www.mempool.space) API (V1)

### Installation

PyPI

```bash

pip install pymempool

```

or from source

```bash

git clone https://github.com/holgern/pymempool.git

cd pymempool

python3 setup.py install

```

### Usage

```python

from pymempool import MempoolAPI

mp = MempoolAPI()

```

### API Documentation

https://mempool.space/docs/api/rest

## Test Suite

### Set up the test environment

Install the test-runner dependencies:

```

pip3 install -r requirements-test.txt

```

Then make the `pymempool` python module visible/importable to the tests by installing the local dev dir as an editable module:

```

# from the repo root

pip3 install -e .

```

### Running the test suite

Run the whole test suite:

```

# from the repo root

pytest

```

Run a specific test file:

```

pytest test/test_this_file.py

```

Run a specific test:

```

pytest test/test_this_file.py::test_this_specific_test

```

### Running tests with tox

Install tox

```

pip install tox

```

Run tests

```

tox

```

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Pre-commit-config

### Installation

```

$ pip install pre-commit

```

### Using homebrew:

```

$ brew install pre-commit

```

```

$ pre-commit --version

pre-commit 2.10.0

```

### Install the git hook scripts

```

$ pre-commit install

```

### Run against all the files

```

pre-commit run --all-files

pre-commit run --show-diff-on-failure --color=always --all-files

```

### Update package rev in pre-commit yaml

```bash

pre-commit autoupdate

pre-commit run --show-diff-on-failure --color=always --all-files

```