electrumsv-node


Nameelectrumsv-node JSON
Version 0.0.15 PyPI version JSON
download
home_pagehttps://github.com/electrumsv/electrumsv-node
SummaryElectrumSV RegTest node
upload_time2020-10-18 06:19:03
maintainerAustEcon
docs_urlNone
authorAustEcon
requires_python
licenseOpen BSV
keywords bitcoinsv bsv bitcoin sv cryptocurrency tools wallet
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://badge.fury.io/py/electrumsv-node.svg)](https://badge.fury.io/py/electrumsv-node) [![Build Status](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-node?branchName=master)](https://dev.azure.com/electrumsv/ElectrumSV/_build/latest?definitionId=5&branchName=master)

# ElectrumSV-Node

The project is intended to provide Python packages for Linux, MacOS and Windows that include and
help run pre-built Bitcoin SV executables. It should allow the consistently usable and available
ability to run a Bitcoin SV node on any 64-bit platform with the installation of the
`electrumsv-node` package using the standard `pip` package manager for Python.

These packages and the executables within them, are only intended for running nodes for development
as Regtest blockchains. If we had the ability to do so, we would prevent them from running as any
other blockchain. Do not bother us with your questions or problems related to non-Regtest usage.

* You must be using 64-bit Python 3.7 or 3.8.
* You must be using Windows, MacOS or Linux.
* You must have the latest version of the `pip` package.

To update `pip`:

    > python3 -m pip install --upgrade pip

To install `electrumsv-node`:

    > pip3 install electrumsv-node

To use it:

    from electrumsv_node import electrumsv_node

    # Set logging level to debug mode to see logging information (Optional)
    logging.basicConfig(
        format="%(asctime)s %(levelname)s %(message)s",
        level=logging.DEBUG,
        datefmt="%Y-%m-%d %H-%M-%S",
    )

    electrumsv_node.start()
    time.sleep(5)
    electrumsv_node.stop()
    time.sleep(5)
    electrumsv_node.reset()

Console output will look something like this (with custom data directory):

    2020-07-03 19-35-57 DEBUG starting RegTest bitcoin daemon...
    2020-07-03 19-36-02 DEBUG stopping RegTest bitcoin daemon...
    2020-07-03 19-36-02 DEBUG bitcoin daemon stopped.
    2020-07-03 19-36-07 DEBUG resetting state of RegTest bitcoin daemon...
    2020-07-03 19-36-09 DEBUG removed 'G:\electrumsv-node\electrumsv_node\data' successfully
    2020-07-03 19-36-09 DEBUG created 'G:\electrumsv-node\electrumsv_node\data' successfully

## The node data directory

By default, the node will be started with a data directory in a standard location. On Windows this
will be within `ElectrumSV-Node` in the computer's `LOCALAPPDATA` directory, which will likely be
`c:\users\<user-name>\AppData\Local`. On MacOS and Linux this will be within `.electrumsv-node` in
the user's home directory, which will likely be something like `/home/<user-name>` on Linux or
`/Users/<user-name>` on MacOS.

## ElectrumSV and ElectrumSV-Node

This is part of a wider effort to provide a first class RegTest development environment
experience with the [ElectrumSV](https://github.com/electrumsv/electrumsv) stack (which includes
ElectrumX). It is expected that for these purposes, the
[ElectrumSV-SDK](https://github.com/electrumsv/electrumsv-sdk) project will be the way that
developers will make use of ElectrumSV-Node.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/electrumsv/electrumsv-node",
    "name": "electrumsv-node",
    "maintainer": "AustEcon",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "AustEcon0922@gmail.com",
    "keywords": "bitcoinsv,bsv,bitcoin sv,cryptocurrency,tools,wallet",
    "author": "AustEcon",
    "author_email": "AustEcon0922@gmail.com",
    "download_url": "https://github.com/electrumsv/electrumsv-node/tarball/0.0.15",
    "platform": "",
    "description": "[![PyPI version](https://badge.fury.io/py/electrumsv-node.svg)](https://badge.fury.io/py/electrumsv-node) [![Build Status](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-node?branchName=master)](https://dev.azure.com/electrumsv/ElectrumSV/_build/latest?definitionId=5&branchName=master)\n\n# ElectrumSV-Node\n\nThe project is intended to provide Python packages for Linux, MacOS and Windows that include and\nhelp run pre-built Bitcoin SV executables. It should allow the consistently usable and available\nability to run a Bitcoin SV node on any 64-bit platform with the installation of the\n`electrumsv-node` package using the standard `pip` package manager for Python.\n\nThese packages and the executables within them, are only intended for running nodes for development\nas Regtest blockchains. If we had the ability to do so, we would prevent them from running as any\nother blockchain. Do not bother us with your questions or problems related to non-Regtest usage.\n\n* You must be using 64-bit Python 3.7 or 3.8.\n* You must be using Windows, MacOS or Linux.\n* You must have the latest version of the `pip` package.\n\nTo update `pip`:\n\n    > python3 -m pip install --upgrade pip\n\nTo install `electrumsv-node`:\n\n    > pip3 install electrumsv-node\n\nTo use it:\n\n    from electrumsv_node import electrumsv_node\n\n    # Set logging level to debug mode to see logging information (Optional)\n    logging.basicConfig(\n        format=\"%(asctime)s %(levelname)s %(message)s\",\n        level=logging.DEBUG,\n        datefmt=\"%Y-%m-%d %H-%M-%S\",\n    )\n\n    electrumsv_node.start()\n    time.sleep(5)\n    electrumsv_node.stop()\n    time.sleep(5)\n    electrumsv_node.reset()\n\nConsole output will look something like this (with custom data directory):\n\n    2020-07-03 19-35-57 DEBUG starting RegTest bitcoin daemon...\n    2020-07-03 19-36-02 DEBUG stopping RegTest bitcoin daemon...\n    2020-07-03 19-36-02 DEBUG bitcoin daemon stopped.\n    2020-07-03 19-36-07 DEBUG resetting state of RegTest bitcoin daemon...\n    2020-07-03 19-36-09 DEBUG removed 'G:\\electrumsv-node\\electrumsv_node\\data' successfully\n    2020-07-03 19-36-09 DEBUG created 'G:\\electrumsv-node\\electrumsv_node\\data' successfully\n\n## The node data directory\n\nBy default, the node will be started with a data directory in a standard location. On Windows this\nwill be within `ElectrumSV-Node` in the computer's `LOCALAPPDATA` directory, which will likely be\n`c:\\users\\<user-name>\\AppData\\Local`. On MacOS and Linux this will be within `.electrumsv-node` in\nthe user's home directory, which will likely be something like `/home/<user-name>` on Linux or\n`/Users/<user-name>` on MacOS.\n\n## ElectrumSV and ElectrumSV-Node\n\nThis is part of a wider effort to provide a first class RegTest development environment\nexperience with the [ElectrumSV](https://github.com/electrumsv/electrumsv) stack (which includes\nElectrumX). It is expected that for these purposes, the\n[ElectrumSV-SDK](https://github.com/electrumsv/electrumsv-sdk) project will be the way that\ndevelopers will make use of ElectrumSV-Node.\n\n\n",
    "bugtrack_url": null,
    "license": "Open BSV",
    "summary": "ElectrumSV RegTest node",
    "version": "0.0.15",
    "split_keywords": [
        "bitcoinsv",
        "bsv",
        "bitcoin sv",
        "cryptocurrency",
        "tools",
        "wallet"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "38ef29a116e888893312c515d660f0b6",
                "sha256": "39926d603c574142d7629ba45eb0799fc03016c9f56ea90d56a58b573b68e4dd"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp37-cp37m-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "38ef29a116e888893312c515d660f0b6",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 7314766,
            "upload_time": "2020-10-18T06:19:03",
            "upload_time_iso_8601": "2020-10-18T06:19:03.538828Z",
            "url": "https://files.pythonhosted.org/packages/4a/59/7a558bc7a4a603dafe55f93467e3e8dbf79f00fe2f9055cefab4e6bbd15c/electrumsv_node-0.0.15-cp37-cp37m-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2c501b7218044ef507ee6ef3648e6937",
                "sha256": "2f1ebd8620fb9b590e4419d13a5177a88fa4a8e752e19016cb4a683169992cf8"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp37-cp37m-manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "2c501b7218044ef507ee6ef3648e6937",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 7508486,
            "upload_time": "2020-10-18T06:19:09",
            "upload_time_iso_8601": "2020-10-18T06:19:09.751990Z",
            "url": "https://files.pythonhosted.org/packages/7a/fb/f7c6ffa25734e65a61f8c74a9d28dc50d2565fcc39d5f9028cb07b9d3970/electrumsv_node-0.0.15-cp37-cp37m-manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "8fbbd83fd69da484c5630bae98533ea5",
                "sha256": "9147432a110f56b021d3f0747947538bc76ea9fd2bb7940258f21f7bd121f0cb"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp37-cp37m-win32.whl",
            "has_sig": false,
            "md5_digest": "8fbbd83fd69da484c5630bae98533ea5",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 8488714,
            "upload_time": "2020-10-18T06:19:16",
            "upload_time_iso_8601": "2020-10-18T06:19:16.439829Z",
            "url": "https://files.pythonhosted.org/packages/d5/16/ed00e9c6e834a555a0cf97d9330cfb9f835e7bd35ef92f8bdbb7b06f167b/electrumsv_node-0.0.15-cp37-cp37m-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "34be06471a699be06511c869268eac03",
                "sha256": "a677d67ef0bb8805f77cd245a20ba06da8ad977d1f1b2bb2b8a4f3bea58de087"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp37-cp37m-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "34be06471a699be06511c869268eac03",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 8488716,
            "upload_time": "2020-10-18T06:19:22",
            "upload_time_iso_8601": "2020-10-18T06:19:22.713445Z",
            "url": "https://files.pythonhosted.org/packages/af/c2/6edf312856adfac2d450c12cb2e4a2f2429a051a387479cba234b81a116d/electrumsv_node-0.0.15-cp37-cp37m-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "269a683167df38b44a13f85f939d418d",
                "sha256": "16b2ace8d66919b2817cc23e44c140db2e7063d29ce634dd58194a9d8d362d5a"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp38-cp38-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "269a683167df38b44a13f85f939d418d",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 7314766,
            "upload_time": "2020-10-18T06:19:29",
            "upload_time_iso_8601": "2020-10-18T06:19:29.386640Z",
            "url": "https://files.pythonhosted.org/packages/a3/0c/c72a5b0f5c4252c64e61f8176c07111a7b0ec967fc6e576a3ce229d9dc03/electrumsv_node-0.0.15-cp38-cp38-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "5cc35769a047d62f5af4adade2b855a0",
                "sha256": "dfba88b497deba0d4834ec0b621de3c19d035c6501e638a67a99fd245252382d"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp38-cp38-manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "5cc35769a047d62f5af4adade2b855a0",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 7508490,
            "upload_time": "2020-10-18T06:19:35",
            "upload_time_iso_8601": "2020-10-18T06:19:35.582516Z",
            "url": "https://files.pythonhosted.org/packages/23/8d/631361edc062c6240938e90d6c87a985743ae23061e63f9a387cc4128fe9/electrumsv_node-0.0.15-cp38-cp38-manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "57b3fe0e5c3c618cae6fad2e3a2af7ec",
                "sha256": "1676cd4ea1df8f0535c311585c34e79d6f74855033b9865fe8838173ecb4a37c"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp38-cp38-win32.whl",
            "has_sig": false,
            "md5_digest": "57b3fe0e5c3c618cae6fad2e3a2af7ec",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 8488710,
            "upload_time": "2020-10-18T06:19:42",
            "upload_time_iso_8601": "2020-10-18T06:19:42.517125Z",
            "url": "https://files.pythonhosted.org/packages/70/13/2f21f264e4922a85f8bddf6b54da3111f5556876237fd325cef14d4b8eac/electrumsv_node-0.0.15-cp38-cp38-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "76155ab2d0e1d99fb3f53671c5a43469",
                "sha256": "86df93cd13f1c423d49447ef685e777f20672694ad712d1d240f08604477303e"
            },
            "downloads": -1,
            "filename": "electrumsv_node-0.0.15-cp38-cp38-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "76155ab2d0e1d99fb3f53671c5a43469",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 8488713,
            "upload_time": "2020-10-18T06:19:49",
            "upload_time_iso_8601": "2020-10-18T06:19:49.182090Z",
            "url": "https://files.pythonhosted.org/packages/d4/44/677497ea31872604dd5da00f7daf6d96612cac2d7d792caa3bad60c0acf4/electrumsv_node-0.0.15-cp38-cp38-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-10-18 06:19:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "electrumsv",
    "error": "Could not fetch GitHub repository",
    "lcname": "electrumsv-node"
}
        
Elapsed time: 0.14652s