Skip to content

Commit f26fba5

Browse files
committed
version 0.11.4 - update README.rst -> .md
- because .rst does not render properly on pypi and looks sloppy.
1 parent d1b1f48 commit f26fba5

File tree

3 files changed

+24
-52
lines changed

3 files changed

+24
-52
lines changed

README.rst renamed to README.md

Lines changed: 22 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,26 @@ BitSV: Bitcoin SV made easy.
33

44
Forked from Ofek's awesome Bit library: https://github.com/ofek/bit
55

6-
.. image:: https://img.shields.io/pypi/v/bitsv.svg?style=flat-square
7-
:target: https://pypi.org/project/bitsv
8-
9-
.. image:: https://img.shields.io/travis/AustEcon/bitsv.svg?branch=master&style=flat-square
10-
:target: https://travis-ci.org/AustEcon/bitsv
11-
12-
.. image:: https://img.shields.io/codecov/c/github/AustEcon/bitsv.svg?style=flat-square
13-
:target: https://codecov.io/gh/austecon/bitsv
14-
15-
.. image:: https://img.shields.io/pypi/pyversions/bitsv.svg?style=flat-square
16-
:target: https://pypi.org/project/bitsv
17-
18-
.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
19-
:target: https://en.wikipedia.org/wiki/MIT_License
206

7+
[![PyPI version](https://img.shields.io/pypi/v/bitsv.svg?style=flat-square)](https://pypi.org/project/bitsv)
8+
[![build status](https://img.shields.io/travis/AustEcon/bitsv.svg?branch=master&style=flat-square)](https://travis-ci.org/AustEcon/bitsv)
9+
[![code cov](https://img.shields.io/codecov/c/github/AustEcon/bitsv.svg?style=flat-square)](https://codecov.io/gh/austecon/bitsv)
10+
[![Python versions](https://img.shields.io/pypi/pyversions/bitsv.svg?style=flat-square)](https://pypi.org/project/bitsv)
11+
[![Python versions](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://en.wikipedia.org/wiki/MIT_License)
2112

2213
Noticeboard:
2314
------------
24-
Latest Major Release - 0.11.3_ (2020-11-7)
25-
26-
.. _0.11.3: https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst
15+
Latest Major Release - [0.11.4](https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst) (2021-01-01)
2716

2817
- Added WhatsOnChain API for mainnet and testnet
2918
- Unspent data type: removed 'script' (scriptpubkey) attribute (unavailable from WhatsOnChain and Satoshi.io APIs and is unused in the codebase).
3019
- Transaction, TxOutput, TxInput data types: removed unnecessary 'cruft' like 'amount_in', 'amount_out' and 'fee' (also to facilitate use of WhatsOnChain etc. and reduce maintenance overheads).
3120
- MatterCloud now activated via **'MATTERCLOUD_API_KEY' environment variable** which makes it the highest priority API in the list for main, test, stn. Otherwise WhatsOnChain is used by default.
32-
- 0.11.1 Fixed an off-by-one bug for generating pushdata op_codes for data-carrier 'op_return' txs - c/o `gitzhou <https://github.com/gitzhou>`_.
21+
- 0.11.1 Fixed an off-by-one bug for generating pushdata op_codes for data-carrier 'op_return' txs - c/o [gitzhou](https://github.com/gitzhou).
3322
- 0.11.2 NetworkAPI.broadcast_tx() now returns the txid instead of null.
3423
- 0.11.3 make 'prepare_transaction' a @classmethod as it should not require a private key (breaking change as function signature now requires the 'network' as a positional argument)
3524

36-
Previous Major Release - 0.10.4_ (2019-02-13)
37-
38-
.. _0.10.4: https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst
25+
Previous Major Release - [0.10.4](https://github.com/AustEcon/bitsv/blob/master/HISTORY.rst) (2019-02-13)
3926

4027
- Added new Fullnode class for connecting to local bitcoin node via JSON-RPC (thanks goes to https://github.com/xloem for the initial legwork).
4128
- Fullnode class works for Mainnet, Testnet, Scaling-testnet and RegTest (local mock blockchain).
@@ -44,7 +31,7 @@ Previous Major Release - 0.10.4_ (2019-02-13)
4431
- Add 'sweep' function to PrivateKey class for sending all coins to a given address.
4532
- 0.10.1 includes a patch for rpc methods list
4633
- 0.10.2 includes a patch to fix broken API endpoint for foreign currency conversions.
47-
- 0.10.3 allow transaction fee less than 1 sat/byte (i.e. float) c/o `gitzhou <https://github.com/gitzhou>`_
34+
- 0.10.3 allow transaction fee less than 1 sat/byte (i.e. float) c/o [gitzhou](https://github.com/gitzhou)
4835
- 0.10.4 update main api url from https://api.bitindex.network to https://api.mattercloud.net
4936

5037

@@ -69,8 +56,7 @@ Examples
6956

7057
1. Simple payment:
7158

72-
.. code-block:: python
73-
59+
```
7460
>>> import bitsv
7561
>>> my_key = bitsv.Key('YourPrivateKeyGoesHere') # Defaults to "main" network
7662
>>> my_key.get_balance()
@@ -83,31 +69,32 @@ Examples
8369
>>> ]
8470
>>> my_key.send(outputs)
8571
'dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1'
72+
```
8673

87-
Here's the transaction `<https://whatsonchain.com/tx/dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1>`_.
74+
Here's the transaction https://whatsonchain.com/tx/dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1.
8875

8976
2. OP_RETURN - 100kb size limit now supported:
9077

91-
.. code-block:: python
92-
78+
```
9379
>>> import bitsv
9480
>>> my_key = bitsv.Key('YourPrivateKeyGoesHere')
9581
>>> list_of_pushdata = ([bytes.fromhex('6d01'), # encode hex to bytes
9682
'New_Name'.encode('utf-8')]) # encode string to utf-8 encoded bytes
9783
>>> my_key.send_op_return(list_of_pushdata) # default fee = 1 sat/byte
84+
```
9885

9986
This sets memo.sv name (linked to this bitcoin address) to "New_Name" (as per https://memo.sv/protocol)
10087

10188
3. Connect to a local 'fullnode' via JSON-RPC:
10289

103-
.. code-block:: python
104-
90+
```
10591
>>> from bitsv import Fullnode
10692
>>> fullnode = FullNode(
10793
conf_dir='/home/username/.bitcoin/regtest.conf',
10894
rpcuser='user',
10995
rpcpassword='password',
11096
network='regtest')
97+
```
11198

11299
Possible use cases may include:
113100

@@ -118,11 +105,9 @@ Possible use cases may include:
118105
The fullnode object has a complete internal list of all JSON-RPC methods added to __dict__ for code completion and methods return appropriate
119106
error messages:
120107

121-
.. figure:: images/obj_dict.png
108+
[![Node autocomplete](images/obj_dict.png)]
122109

123-
For more detailed examples of using the Fullnode class, see README_
124-
125-
.. _README: https://github.com/AustEcon/bitsv/blob/master/bitsv/network/services/README.rst
110+
For more detailed examples of using the Fullnode class, see [README](https://github.com/AustEcon/bitsv/blob/master/bitsv/network/services/README.rst)
126111

127112
Features
128113
--------
@@ -141,7 +126,6 @@ Installation
141126
BitSV is distributed on `PyPI` as a universal wheel and is available on Linux/macOS
142127
and Windows and supports Python 3.5+ and PyPy3.5-v5.7.1+. ``pip`` >= 8.1.2 is required.
143128

144-
.. code-block:: bash
145129

146130
$ pip install bitsv # pip3 if pip is Python 2 on your system.
147131

@@ -153,19 +137,7 @@ Docs are hosted by Github Pages and are automatically built and published by Tra
153137
Credits
154138
-------
155139

156-
- `ofek`_ for the original bit codebase.
157-
- `teran-mckinney`_ for his work on the bitcash fork
158-
- `joshua smith`_ for adding BitIndex3
159-
- `xloem`_ for help with adding Fullnode connectivity
160-
161-
.. _ofek: https://github.com/ofek/bit
162-
.. _teran-mckinney: https://github.com/sporestack/bitcash
163-
.. _joshua Smith: https://github.com/joshua-s
164-
.. _xloem: https://github.com/xloem
165-
166-
Donate
167-
--------
168-
169-
- If you have found this library useful, please consider donating. It really helps.
170-
- HandCash: $AustEcon
171-
- 1PdvVPTzXmo4cSs68HctLUxAdW917UZtC8
140+
- [ofek](https://github.com/ofek/bit)
141+
- [teran-mckinney](https://github.com/sporestack/bitcash)
142+
- [joshua Smith](https://github.com/joshua-s)
143+
- [xloem](https://github.com/xloem)

bitsv/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
from bitsv.network.services import set_service_timeout, FullNode
44
from bitsv.wallet import Key, PrivateKey, wif_to_key
55

6-
__version__ = '0.11.3'
6+
__version__ = '0.11.4'

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
name='bitsv',
1111
version=version,
1212
description='Bitcoin SV made easier.',
13-
long_description=open('README.rst', 'r').read(),
13+
long_description=open('README.md', 'r').read(),
1414
long_description_content_type='text/markdown',
1515
author='AustEcon',
1616
author_email='[email protected]',

0 commit comments

Comments
 (0)