electrumsv-sdk


Nameelectrumsv-sdk JSON
Version 0.0.50 PyPI version JSON
download
home_pagehttps://github.com/electrumsv/electrumsv-sdk
SummaryElectrumSV SDK
upload_time2023-01-16 23:53:34
maintainerRoger Taylor
docs_urlNone
authorRoger Taylor
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.
            ElectrumSV Software Development Kit
===================================

This project provides a consolidated set of resources that together can allow a developer, whether
working on ElectrumSV directly or on an application based on ElectrumSV, to develop, run and test
while offline (and is especially aimed at facilitating rigourous CI/CD functional testing).

    Licence: The Open BSV License
    Maintainers: Roger Taylor, AustEcon
    Project Lead: Roger Taylor
    Language: Python (>=3.9)
    Homepage: https://electrumsv.io/

[![PyPI version](https://badge.fury.io/py/electrumsv-sdk.svg)](https://badge.fury.io/py/electrumsv-sdk)
[![Build Status](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-sdk?branchName=master)](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-sdk?branchName=master)
[![Platforms](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)
[![Platforms](https://img.shields.io/pypi/pyversions/electrumsv-sdk.svg?style=flat-square)](https://pypi.org/project/electrumsv-sdk)

Documentation
================
Detailed documentation is hosted [here](https://electrumsv-sdk.readthedocs.io/en/latest/)

Basic Instructions
===================
To install from [pypi](https://pypi.org/project/electrumsv-sdk/):

    > pip install --upgrade electrumsv-sdk

Now you have global access to a script called 'electrumsv-sdk.exe' from
any console window.

For help:

    > electrumsv-sdk --help

**Note: You must run ``electrumsv-sdk install <component type>``
first for each component type. This may require system dependencies
you also need - please read the documentation.**

If you want help for one of the subcommands (e.g. 'start') do:

    > electrumsv-sdk start --help

Which will show:

    usage: electrumsv-sdk start [-h] [--new] [--gui] [--background] [--inline] [--new-terminal] [--id ID] [--repo REPO] [--branch BRANCH] {electrumsv,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api} ...

    positional arguments:
      {electrumsv,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api}
                            subcommand
        electrumsv          start electrumsv
        merchant_api        start merchant_api
        node                start node
        status_monitor      start status_monitor
        whatsonchain        start whatsonchain
        whatsonchain_api    start whatsonchain_api

    optional arguments:
      -h, --help            show this help message and exit
      --new                 run a new instance with unique 'id'
      --gui                 run in gui mode (electrumsv only)
      --background          spawn in background
      --inline              spawn in current shell
      --new-terminal        spawn in a new terminal window
      --id ID               human-readable identifier for component (e.g. 'worker1_esv')
      --repo REPO           git repo as either an https://github.com url or a local git repo path e.g. G:/electrumsv (optional)
      --branch BRANCH       git repo branch (optional)

Note: The "optional arguments" come **before** specifying the ``component_type`` e.g.:

    > electrumsv-sdk start --new --id=myspecialnode node


Docker
===================
Docker support is here: https://github.com/electrumsv/electrumsv-sdk-docker. However,
do note that we cannot promise to keep the docker support up-to-date as we are stretched
too thin and have other priorities. Nevertheless, help will be gladly accepted.

You might also find what you need here: https://github.com/jadwahab/regtest-stack.
Please check that one out too. Jad and co. are better placed to keep up with the bleeding
edge versioning of the node, mAPI and LiteClient services as they are directly involved
with many of those projects. They also do not have the additional python layer of
abstraction to sort out when it comes to docker.

App Versions
============
The current versions of each component are maintained in 
`electrumsv_sdk/app_versions.py`.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/electrumsv/electrumsv-sdk",
    "name": "electrumsv-sdk",
    "maintainer": "Roger Taylor",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "roger.taylor.email@gmail.com",
    "keywords": "bitcoinsv,bsv,bitcoin sv,cryptocurrency,tools,wallet",
    "author": "Roger Taylor",
    "author_email": "roger.taylor.email@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/fb/07/8f5ff3c71a176f3798c03ff998faa779248277333df9e3f1c0c6ac7b8346/electrumsv-sdk-0.0.50.tar.gz",
    "platform": null,
    "description": "ElectrumSV Software Development Kit\r\n===================================\r\n\r\nThis project provides a consolidated set of resources that together can allow a developer, whether\r\nworking on ElectrumSV directly or on an application based on ElectrumSV, to develop, run and test\r\nwhile offline (and is especially aimed at facilitating rigourous CI/CD functional testing).\r\n\r\n    Licence: The Open BSV License\r\n    Maintainers: Roger Taylor, AustEcon\r\n    Project Lead: Roger Taylor\r\n    Language: Python (>=3.9)\r\n    Homepage: https://electrumsv.io/\r\n\r\n[![PyPI version](https://badge.fury.io/py/electrumsv-sdk.svg)](https://badge.fury.io/py/electrumsv-sdk)\r\n[![Build Status](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-sdk?branchName=master)](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-sdk?branchName=master)\r\n[![Platforms](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)\r\n[![Platforms](https://img.shields.io/pypi/pyversions/electrumsv-sdk.svg?style=flat-square)](https://pypi.org/project/electrumsv-sdk)\r\n\r\nDocumentation\r\n================\r\nDetailed documentation is hosted [here](https://electrumsv-sdk.readthedocs.io/en/latest/)\r\n\r\nBasic Instructions\r\n===================\r\nTo install from [pypi](https://pypi.org/project/electrumsv-sdk/):\r\n\r\n    > pip install --upgrade electrumsv-sdk\r\n\r\nNow you have global access to a script called 'electrumsv-sdk.exe' from\r\nany console window.\r\n\r\nFor help:\r\n\r\n    > electrumsv-sdk --help\r\n\r\n**Note: You must run ``electrumsv-sdk install <component type>``\r\nfirst for each component type. This may require system dependencies\r\nyou also need - please read the documentation.**\r\n\r\nIf you want help for one of the subcommands (e.g. 'start') do:\r\n\r\n    > electrumsv-sdk start --help\r\n\r\nWhich will show:\r\n\r\n    usage: electrumsv-sdk start [-h] [--new] [--gui] [--background] [--inline] [--new-terminal] [--id ID] [--repo REPO] [--branch BRANCH] {electrumsv,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api} ...\r\n\r\n    positional arguments:\r\n      {electrumsv,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api}\r\n                            subcommand\r\n        electrumsv          start electrumsv\r\n        merchant_api        start merchant_api\r\n        node                start node\r\n        status_monitor      start status_monitor\r\n        whatsonchain        start whatsonchain\r\n        whatsonchain_api    start whatsonchain_api\r\n\r\n    optional arguments:\r\n      -h, --help            show this help message and exit\r\n      --new                 run a new instance with unique 'id'\r\n      --gui                 run in gui mode (electrumsv only)\r\n      --background          spawn in background\r\n      --inline              spawn in current shell\r\n      --new-terminal        spawn in a new terminal window\r\n      --id ID               human-readable identifier for component (e.g. 'worker1_esv')\r\n      --repo REPO           git repo as either an https://github.com url or a local git repo path e.g. G:/electrumsv (optional)\r\n      --branch BRANCH       git repo branch (optional)\r\n\r\nNote: The \"optional arguments\" come **before** specifying the ``component_type`` e.g.:\r\n\r\n    > electrumsv-sdk start --new --id=myspecialnode node\r\n\r\n\r\nDocker\r\n===================\r\nDocker support is here: https://github.com/electrumsv/electrumsv-sdk-docker. However,\r\ndo note that we cannot promise to keep the docker support up-to-date as we are stretched\r\ntoo thin and have other priorities. Nevertheless, help will be gladly accepted.\r\n\r\nYou might also find what you need here: https://github.com/jadwahab/regtest-stack.\r\nPlease check that one out too. Jad and co. are better placed to keep up with the bleeding\r\nedge versioning of the node, mAPI and LiteClient services as they are directly involved\r\nwith many of those projects. They also do not have the additional python layer of\r\nabstraction to sort out when it comes to docker.\r\n\r\nApp Versions\r\n============\r\nThe current versions of each component are maintained in \r\n`electrumsv_sdk/app_versions.py`.\r\n",
    "bugtrack_url": null,
    "license": "Open BSV",
    "summary": "ElectrumSV SDK",
    "version": "0.0.50",
    "split_keywords": [
        "bitcoinsv",
        "bsv",
        "bitcoin sv",
        "cryptocurrency",
        "tools",
        "wallet"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "224910e5ed72e4925850cc3470225af2c5d1859bab2e96eba12a4841d28e71d0",
                "md5": "15f12933850bff3accbc854f1638cf20",
                "sha256": "541bf431e49302ce5245025d746bd33ee98242dba87a7847c0be00c9a7b1846e"
            },
            "downloads": -1,
            "filename": "electrumsv_sdk-0.0.50-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "15f12933850bff3accbc854f1638cf20",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 104898,
            "upload_time": "2023-01-16T23:53:32",
            "upload_time_iso_8601": "2023-01-16T23:53:32.157261Z",
            "url": "https://files.pythonhosted.org/packages/22/49/10e5ed72e4925850cc3470225af2c5d1859bab2e96eba12a4841d28e71d0/electrumsv_sdk-0.0.50-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb078f5ff3c71a176f3798c03ff998faa779248277333df9e3f1c0c6ac7b8346",
                "md5": "1410ba6e433f9f8c259de01605e2d796",
                "sha256": "76e617c47fe9b107f480b8459374160b8b85e938ab3b4003488808a7f2d4724b"
            },
            "downloads": -1,
            "filename": "electrumsv-sdk-0.0.50.tar.gz",
            "has_sig": false,
            "md5_digest": "1410ba6e433f9f8c259de01605e2d796",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 72548,
            "upload_time": "2023-01-16T23:53:34",
            "upload_time_iso_8601": "2023-01-16T23:53:34.423195Z",
            "url": "https://files.pythonhosted.org/packages/fb/07/8f5ff3c71a176f3798c03ff998faa779248277333df9e3f1c0c6ac7b8346/electrumsv-sdk-0.0.50.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-16 23:53:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "electrumsv",
    "github_project": "electrumsv-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "electrumsv-sdk"
}
        
Elapsed time: 0.02918s