bdkpython - pypi Package Compare versions

Comparing version 0.0.2 to 0.0.3

PKG-INFO

 Metadata-Version: 2.1
 Name: bdkpython
-Version: 0.0.2
-Summary: UNKNOWN
-Home-page: UNKNOWN
-License: UNKNOWN
+Version: 0.0.3
+Summary: The Python language bindings for the bitcoindevkit
+Home-page: https://github.com/bitcoindevkit/bdk-ffi
+Author: Alekos Filini <[e-mail]>, Steve Myers <[e-mail]>
+License: MIT or Apache 2.0
 Platform: UNKNOWN
+Description-Content-Type: text/markdown
 
-UNKNOWN
+# bdkpython
+The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
 
+## Install the package
+```shell
+pip install bdkpython
+```
+
+## Simple examples
+**Generate a testnet address**
+```python
+import bdkpython as bdk
+
+
+descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)"
+config = bdk.DatabaseConfig.MEMORY("")
+
+wallet = bdk.OfflineWallet(descriptor, bdk.Network.TESTNET, config)
+address = wallet.get_new_address()
+print(f"New BIP84 testnet address: {address}")
+```  
+
+**Sync a wallet using Electrum**
+```python
+import bdkpython as bdk
+
+descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)"
+config = bdk.DatabaseConfig.MEMORY("")
+client = bdk.BlockchainConfig.ELECTRUM(
+             bdk.ElectrumConfig(
+                 "ssl://electrum.blockstream.info:60002",
+                 None,
+                 5,
+                 None,
+                 100
+             )   
+         )
+
+wallet = bdk.OnlineWallet(
+             descriptor=descriptor,
+             change_descriptor=descriptor,
+             network=bdk.Network.TESTNET,
+             database_config=config,
+             blockchain_config=client
+         )
+
+class LogProgress(bdk.BdkProgress):
+    def update(self, progress, update):
+        pass
+        
+wallet.sync(progress_update=LogProgress(), max_address_param=20)
+balance = wallet.get_balance()
+print(f"Wallet balance is: {balance}")
+```
+
+

setup.py

@@ -5,5 +5,61 @@ #!/usr/bin/env python
 
+LONG_DESCRIPTION = """# bdkpython
+The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
+
+## Install the package
+```shell
+pip install bdkpython
+```
+
+## Simple examples
+**Generate a testnet address**
+```python
+import bdkpython as bdk
+
+
+descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)"
+config = bdk.DatabaseConfig.MEMORY("")
+
+wallet = bdk.OfflineWallet(descriptor, bdk.Network.TESTNET, config)
+address = wallet.get_new_address()
+print(f"New BIP84 testnet address: {address}")
+```  
+
+**Sync a wallet using Electrum**
+```python
+import bdkpython as bdk
+
+descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)"
+config = bdk.DatabaseConfig.MEMORY("")
+client = bdk.BlockchainConfig.ELECTRUM(
+             bdk.ElectrumConfig(
+                 "ssl://electrum.blockstream.info:60002",
+                 None,
+                 5,
+                 None,
+                 100
+             )   
+         )
+
+wallet = bdk.OnlineWallet(
+             descriptor=descriptor,
+             change_descriptor=descriptor,
+             network=bdk.Network.TESTNET,
+             database_config=config,
+             blockchain_config=client
+         )
+
+class LogProgress(bdk.BdkProgress):
+    def update(self, progress, update):
+        pass
+        
+wallet.sync(progress_update=LogProgress(), max_address_param=20)
+balance = wallet.get_balance()
+print(f"Wallet balance is: {balance}")
+```
+"""
+
 setup(
     name='bdkpython',
-    version='0.0.2',
+    version='0.0.3',
     packages=find_packages(where="src"),
@@ -14,2 +70,8 @@ package_dir={"": "src"},
     zip_safe=False,
+    description="The Python language bindings for the bitcoindevkit",
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type='text/markdown',
+    url="https://github.com/bitcoindevkit/bdk-ffi",
+    author="Alekos Filini <[e-mail]>, Steve Myers <[e-mail]>",
+    license="MIT or Apache 2.0",
 )

src/bdkpython.egg-info/PKG-INFO

 Metadata-Version: 2.1
 Name: bdkpython
-Version: 0.0.2
-Summary: UNKNOWN
-Home-page: UNKNOWN
-License: UNKNOWN
+Version: 0.0.3
+Summary: The Python language bindings for the bitcoindevkit
+Home-page: https://github.com/bitcoindevkit/bdk-ffi
+Author: Alekos Filini <[e-mail]>, Steve Myers <[e-mail]>
+License: MIT or Apache 2.0
 Platform: UNKNOWN
+Description-Content-Type: text/markdown
 
-UNKNOWN
+# bdkpython
+The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
 
+## Install the package
+```shell
+pip install bdkpython
+```
+
+## Simple examples
+**Generate a testnet address**
+```python
+import bdkpython as bdk
+
+
+descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)"
+config = bdk.DatabaseConfig.MEMORY("")
+
+wallet = bdk.OfflineWallet(descriptor, bdk.Network.TESTNET, config)
+address = wallet.get_new_address()
+print(f"New BIP84 testnet address: {address}")
+```  
+
+**Sync a wallet using Electrum**
+```python
+import bdkpython as bdk
+
+descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)"
+config = bdk.DatabaseConfig.MEMORY("")
+client = bdk.BlockchainConfig.ELECTRUM(
+             bdk.ElectrumConfig(
+                 "ssl://electrum.blockstream.info:60002",
+                 None,
+                 5,
+                 None,
+                 100
+             )   
+         )
+
+wallet = bdk.OnlineWallet(
+             descriptor=descriptor,
+             change_descriptor=descriptor,
+             network=bdk.Network.TESTNET,
+             database_config=config,
+             blockchain_config=client
+         )
+
+class LogProgress(bdk.BdkProgress):
+    def update(self, progress, update):
+        pass
+        
+wallet.sync(progress_update=LogProgress(), max_address_param=20)
+balance = wallet.get_balance()
+print(f"Wallet balance is: {balance}")
+```
+
+

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

7281209

0.08%

Lines of code

1634

3.22%