Sitelet https://github.com/legion2002/BitcoinCorePython/commit/3603bad2e3394fac2ea893e7721cf4c99b4d3a52
Skip to content

Commit 3603bad

Browse files
4tochka4tochka
authored
Merge pull request #4 from bitaps-com/2.0
2.0
2 parents 7b59853 + 2eed4aa commit 3603bad

25 files changed

Lines changed: 939 additions & 208 deletions

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/src/alabaster"]
2+
path = docs/src/alabaster
3+
url = https://github.com/bitprophet/alabaster.git

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<img src="doc/img/pybtc.png" width="100">
1+
<img src="docs/img/pybtc.png" width="100">
22

33
## Python bitcoin library

‎change.log‎

Whitespace-only changes.

‎docs/.DS_Store‎

8 KB
Binary file not shown.

‎docs/_build/.DS_Store‎

6 KB
Binary file not shown.

‎docs/img/.DS_Store‎

6 KB
Binary file not shown.

‎docs/source/address.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
=========
2+
Addresses
3+
=========
4+
5+
Collection of base classes that implement the work with Bitcoin addresses and address keys.
6+
Supports addresses types PUBKEY, P2PKH, P2SH, P2SH-PWPKH, P2WPKH, P2WSH.
7+
8+
|
9+
|
10+
11+
.. autoclass:: pybtc.PrivateKey
12+
:members:
13+
:inherited-members:
14+
15+
|
16+
|
17+
18+
.. autoclass:: pybtc.PublicKey
19+
:members:
20+
:inherited-members:
21+
22+
|
23+
|
24+
25+
.. autoclass:: pybtc.Address
26+
:members:
27+
:inherited-members:
28+
29+
30+

‎docs/source/classes.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=========
2+
Reference
3+
=========
4+
5+
.. toctree::
6+
:name: mastertoc
7+
:maxdepth: 2
8+
9+
address.rst
10+
transaction.rst
11+
block.rst
12+
13+

‎docs/source/conf.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
#
1515
import os
1616
import sys
17+
from sphinx.ext.autodoc import (
18+
ClassLevelDocumenter, InstanceAttributeDocumenter)
19+
1720

1821
sys.path.insert(0, os.path.abspath('.'))
1922
sys.path.insert(0, os.path.abspath('..'))
@@ -28,10 +31,14 @@
2831
# -- Project information -----------------------------------------------------
2932

3033
project = 'pybtc'
31-
copyright = '2018, Aleksey Karpov'
34+
copyright = '2015-2018, bitaps.com'
3235
author = 'Aleksey Karpov'
3336

3437

38+
def iad_add_directive_header(self, sig):
39+
ClassLevelDocumenter.add_directive_header(self, sig)
40+
41+
InstanceAttributeDocumenter.add_directive_header = iad_add_directive_header
3542

3643
# The short X.Y version
3744
version = ''

‎docs/source/contributing.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _pybtc-contributing:
2+
3+
============
4+
Contributing
5+
============
6+
7+
Instructions for contributors
8+
-----------------------------
9+
10+
11+
In order to make a clone of the GitHub repo: open the link and press the
12+
"Fork" button on the upper-right menu of the web page.
13+
14+
15+
Workflow is pretty straightforward:
16+
17+
1. Clone the GitHub
18+
19+
2. Make a change
20+
21+
3. Make sure all tests passed
22+
23+
4. Add a record intp file into ``change.log``.
24+
25+
5. Commit changes to own aiohttp clone
26+
27+
6. Make pull request from github page for your clone against master branch
28+
29+
30+
Tests coverage
31+
--------------
32+
33+
We are trying hard to have good test coverage; please don't make it worse.
34+
All tests located in ``tests/`` folder.
35+
36+

0 commit comments

Comments
 (0)