pymempool


Namepymempool JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryPython Api for mempool.space
upload_time2024-03-21 07:42:51
maintainerNone
docs_urlNone
authorNone
requires_python>3.7.0
licenseMIT License Copyright (c) 2022 Holger Nahrstaedt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords mempool btc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # 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
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pymempool",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">3.7.0",
    "maintainer_email": null,
    "keywords": "mempool, btc",
    "author": null,
    "author_email": "Holger Nahrstaedt <nahrstaedt@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/c7/7b/4b25805099b9ca5bc1e55737e910e9c3750ef816ad5af2d4ddbc584caec9/pymempool-0.1.3.tar.gz",
    "platform": null,
    "description": "# mempool.space API wrapper\n\n[![codecov](https://codecov.io/gh/holgern/pymempool/graph/badge.svg?token=VyIU0ZxwpD)](https://codecov.io/gh/holgern/pymempool)\n[![PyPi Version](https://img.shields.io/pypi/v/pymempool.svg)](https://pypi.python.org/pypi/pymempool/)\n\nPython3 wrapper around the [mempool.space](https://www.mempool.space) API (V1)\n\n### Installation\nPyPI\n```bash\npip install pymempool\n```\nor from source\n```bash\ngit clone https://github.com/holgern/pymempool.git\ncd pymempool\npython3 setup.py install\n```\n\n### Usage\n\n```python\nfrom pymempool import MempoolAPI\nmp = MempoolAPI()\n```\n\n\n### API Documentation\nhttps://mempool.space/docs/api/rest\n\n## Test Suite\n\n### Set up the test environment\n\nInstall the test-runner dependencies:\n```\npip3 install -r requirements-test.txt\n```\n\nThen make the `pymempool` python module visible/importable to the tests by installing the local dev dir as an editable module:\n```\n# from the repo root\npip3 install -e .\n```\n\n### Running the test suite\nRun the whole test suite:\n```\n# from the repo root\npytest\n```\n\nRun a specific test file:\n```\npytest test/test_this_file.py\n```\n\nRun a specific test:\n```\npytest test/test_this_file.py::test_this_specific_test\n```\n\n### Running tests with tox\n\nInstall tox\n\n```\npip install tox\n```\n\nRun tests\n\n```\ntox\n```\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n## Pre-commit-config\n\n### Installation\n\n```\n$ pip install pre-commit\n```\n\n### Using homebrew:\n```\n$ brew install pre-commit\n```\n\n```\n$ pre-commit --version\npre-commit 2.10.0\n```\n\n### Install the git hook scripts\n\n```\n$ pre-commit install\n```\n\n### Run against all the files\n```\npre-commit run --all-files\npre-commit run --show-diff-on-failure --color=always --all-files\n```\n\n### Update package rev in pre-commit yaml\n```bash\npre-commit autoupdate\npre-commit run --show-diff-on-failure --color=always --all-files\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022 Holger Nahrstaedt  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Python Api for mempool.space",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/holgern/pymempool"
    },
    "split_keywords": [
        "mempool",
        " btc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2176cdd5bab0e138ce24589937a287013f9ff5eb55f424b53a47fe9161f7ecea",
                "md5": "64609032d7af755ad9b357175c0a5da4",
                "sha256": "16773d955f142fb3ed0b3bd69dde0c32962bec969e9485d84ef587eddd65fa2d"
            },
            "downloads": -1,
            "filename": "pymempool-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64609032d7af755ad9b357175c0a5da4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.7.0",
            "size": 11897,
            "upload_time": "2024-03-21T07:42:49",
            "upload_time_iso_8601": "2024-03-21T07:42:49.787784Z",
            "url": "https://files.pythonhosted.org/packages/21/76/cdd5bab0e138ce24589937a287013f9ff5eb55f424b53a47fe9161f7ecea/pymempool-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c77b4b25805099b9ca5bc1e55737e910e9c3750ef816ad5af2d4ddbc584caec9",
                "md5": "0ffa019e490f355d61436b06e20c5e30",
                "sha256": "c0fd101fd611196cb54088df5cff146c8194bc2cf78d7d42b0c4b057c2c9dc4a"
            },
            "downloads": -1,
            "filename": "pymempool-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "0ffa019e490f355d61436b06e20c5e30",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.7.0",
            "size": 16982,
            "upload_time": "2024-03-21T07:42:51",
            "upload_time_iso_8601": "2024-03-21T07:42:51.318081Z",
            "url": "https://files.pythonhosted.org/packages/c7/7b/4b25805099b9ca5bc1e55737e910e9c3750ef816ad5af2d4ddbc584caec9/pymempool-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-21 07:42:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "holgern",
    "github_project": "pymempool",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "circle": true,
    "requirements": [],
    "lcname": "pymempool"
}
        
Elapsed time: 0.20405s