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:

$ pip 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.1.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

turtlecoin-0.1.1-py2.py3-none-any.whl (12.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for turtlecoin-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5de66a4ae2dda59a66cdb51ab75c8795216c054422bf0d17adfdc139b09ca5b5
MD5 7769f2ed2c1249c677e20a2d69b756ed
BLAKE2b-256 c0e8bcf40f3971860207fe10c6cfb8f40859cdc80cc72ddd409dd3cb6a0f29eb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for turtlecoin-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 86fd81b335dec2a20400a63340541f2c1100b39cde9a851529e23568148d166a
MD5 37e6c7f2da1c222e9ee585d1715bf9ee
BLAKE2b-256 e7743358b2706a2873619b08c7c044b867212812505e4bc71078cac2a8ce77f5

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