Skip to main content

A Python wrapper for the TurtleCoin JSON-RPC interface

Project description

https://img.shields.io/pypi/v/turtlecoin.svg https://img.shields.io/pypi/pyversions/turtlecoin.svg https://img.shields.io/pypi/l/turtlecoin.svg https://readthedocs.org/projects/turtlecoin-python/badge/

A Python wrapper for the TurtleCoin JSON-RPC API.

It integrates with Walletd and TurtleCoind and works with TurtleCoin 0.5.0.

Example

wallet.get_addresses()
'TRTLv1abcdef...'
{'id': 0, 'jsonrpc': '2.0', 'result': {'addresses': ['TRTLv2R....']}}

wallet.get_balance()
{'id': 0, 'jsonrpc': '2.0', 'result': {'availableBalance': 50, 'lockedAmount': 0}}

recipients = [{'address': 'TRTLv3abcd123...', 'amount': 50}]
wallet.send_transaction(transfers=recipients)
{'id': 0, 'jsonrpc': '2.0', 'result': {'transactionHash': 'ae57e...'}}

Installation

You can install the latest version from PyPI:

$ pip3 install turtlecoin

Documentation

The documentation is available at http://turtlecoin-python.readthedocs.io

Developer setup

Clone the repo and install the dependencies with …pipenv:

$ git clone ...
$ cd turtlecoin-python
$ pipenv install --dev

To generate the HTML documentation you need to have the turtlecoin module in your PYTHONPATH. This is used to automatically generate the api docs. Afterwards you can run the makefile target:

$ pipenv run python setup.py develop
$ pipenv run make html

The documentation on readthedocs is automatically updated on each push to the master branch (via webhook).

To release a new version on PyPI, increment the version number in turtlecoin/__version__.py and run:

$ pipenv run python setup.py upload

This will also create a git tag with the version number.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

turtlecoin-0.2.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

turtlecoin-0.2.0-py2.py3-none-any.whl (14.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file turtlecoin-0.2.0.tar.gz.

File metadata

  • Download URL: turtlecoin-0.2.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for turtlecoin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 55652df57b89d4e70654eb55a9b4c91aa55031b68e07899b541d29ce03e4a93c
MD5 166ccb97bdd04f34d3d514c4e9b0b5f3
BLAKE2b-256 f8af1f3a3c760b650aa775c54af66daff6c68171f3e962af10fc6f5ee84f85de

See more details on using hashes here.

File details

Details for the file turtlecoin-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for turtlecoin-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 75f99cbbdd1a843913cdf93868eb86b311c80e5dd6023aab3b1dbc4d8c1968ea
MD5 6ee618be1f2096540b332b496df13a7a
BLAKE2b-256 083c4b8d13e6af9d61260c8af68ae2286a70a2de568652181d010e3ae587df6e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page