pyflo/docs/source/index.rst
2018-06-19 01:22:26 +04:00

114 lines
1.7 KiB
ReStructuredText

.. aiohttp documentation master file, created by
sphinx-quickstart on Wed Mar 5 12:35:35 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==================
Welcome to PYBTC
==================
Python library for Bitcoin.
Current version is |release|.
.. _GitHub: https://github.com/bitaps-com/pybtc
Key Features
============
- Supports addresses types PUBKEY, P2PKH, P2SH, P2SH-PWPKH, P2WPKH, P2WSH.
- Supports BIP32(Hierarchical Deterministic Wallets), BIP39(Mnemonic code generation)
- Supports BIP141(Segregated Witness)
- Transaction constructor
- Mining pool basic primitives
.. _aiohttp-installation:
Library Installation
====================
.. code-block:: bash
$ pip install secp256k1
$ pip install pybtc
Getting Started
===============
Client example::
import pybtc
import asyncio
Server example::
import pybtc
What's new in pybtc 2?
========================
Tutorial
========
Source code
===========
The project is hosted on GitHub_
Please feel free to file an issue on the `bug tracker
<https://github.com/bitaps-com/pybtc/issues>`_ if you have found a bug
or have some suggestion in order to improve the library.
Dependencies
============
- Python 3.3.3+
- *secp256k1*
Communication channels
======================
Contributing
============
Authors and License
===================
The ``pybtc`` package is written mostly by Aleksey Karpov.
It's *GPL-3.0* licensed and freely available.
Feel free to improve this package and send a pull request to GitHub_.
Table Of Contents
=================
.. toctree::
:name: mastertoc
:maxdepth: 2
functional.rst