Metadata-Version: 2.1
Name: coinaddr
Version: 1.0.0
Summary: A crypto-currency address inspection/validation library.
Home-page: https://github.com/joeblackwaslike/coinaddr
Author: Joe Black
Author-email: me@joeblack.nyc
Maintainer: Joe Black
Maintainer-email: me@joeblack.nyc
License: MIT
Download-URL: https://github.com/joeblackwaslike/coinaddr/tarball/v1.0.0
Keywords: bitcoin,litecoin,altcoin,ethereum,address,validation,inspection
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: attrs (>=17.4.0)
Requires-Dist: pysha3 (>=1.0.2)
Requires-Dist: base58check (>=1.0.1)


CoinAddr
========


.. image:: https://travis-ci.org/joeblackwaslike/coinaddr.svg?branch=master
   :target: https://travis-ci.org/joeblackwaslike/coinaddr
   :alt: Build Status

.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
   :target: https://github.com/joeblackwaslike/coinaddr
   :alt: Github Repo

.. image:: https://img.shields.io/pypi/v/coinaddr.svg
   :target: https://pypi.python.org/pypi/coinaddr
   :alt: Pypi Version

.. image:: https://img.shields.io/pypi/l/coinaddr.svg
   :target: https://pypi.python.org/pypi/coinaddr
   :alt: Pypi License

.. image:: https://img.shields.io/pypi/wheel/coinaddr.svg
   :target: https://pypi.python.org/pypi/coinaddr
   :alt: Pypi Wheel

.. image:: https://img.shields.io/pypi/pyversions/coinaddr.svg
   :target: https://pypi.python.org/pypi/coinaddr
   :alt: Pypi Versions


Maintainer
----------

Joe Black | me@joeblack.nyc | `github <https://github.com/joeblackwaslike>`_

Introduction
------------

A cryptocurrency address inspection/validation library for python.

Supported currencies
^^^^^^^^^^^^^^^^^^^^


* bitcoin
* bitcoin-cash
* litecoin
* ethereum
* ethereum-classic
* ether-zero
* dogecoin
* dashcoin
* neocoin
* ripple

Installation
------------

.. code-block:: shell

   pip3 install coinaddr

Usage
-----

.. code-block:: python

   >>> import coinaddr
   >>> coinaddr.validate('btc', b'1BoatSLRHtKNngkdXEeobR76b53LETtpyT')
   ValidationResult(name='bitcoin', ticker='btc', address=b'1BoatSLRHtKNngkdXEeobR76b53LETtpyT', valid=True, network='main')

Changes
-------


* `CHANGELOG <CHANGELOG.md>`_


