Merge pull request #2 from blockfrost/PyPI

PyPi and API version v0.1.30

Author: Mathias Frøhlich

.github/workflows/python-package.yml renamed to .github/workflows/package-test.yml

@@ -1,11 +1,9 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: Python package
+name: Package Test
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - '**'
   pull_request:
     branches: [ master ]
 

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,43 @@
+#https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build-n-publish:
+
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish distribution 📦 to Test PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        skip_existing: true
+        user: __token__
+        password: ${{ secrets.TESTNET_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -1,4 +1,8 @@
-[![Python package](https://github.com/blockfrost/blockfrost-python/actions/workflows/python-package.yml/badge.svg)](https://github.com/blockfrost/blockfrost-python/actions/workflows/python-package.yml)
+[![Package Test](https://github.com/blockfrost/blockfrost-python/actions/workflows/package-test.yml/badge.svg)](https://github.com/blockfrost/blockfrost-python/actions/workflows/package-test.yml)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/blockfrost-python.svg)](https://pypi.org/project/blockfrost-python/)
+[![Package Status](https://img.shields.io/pypi/status/blockfrost-python.svg)](https://pypi.org/project/blockfrost-python/)
+[![License](https://img.shields.io/pypi/l/blockfrost-python.svg)](https://github.com/blockfrost/blockfrost-python/blob/master/LICENSE)
+
 
 <img src="https://blockfrost.io/images/logo.svg" width="250" align="right" height="90">
 
@@ -26,7 +30,7 @@ your API key.
 ## Installation
 
 ```console
-$ pip install git+https://github.com/blockfrost/blockfrost-python
+$ pip install blockfrost-python
 ```
 
 <br/>
@@ -47,8 +51,14 @@ api = BlockFrostApi(
 )
 try:
     health = api.health()
-    print(health.is_healthy)  # True
-
+    print(health)   # prints object:    HealthResponse(is_healthy=True)
+    health = api.health(return_type='json') # Can be useful if python wrapper is behind api version
+    print(health)   # prints json:      {"is_healthy":True}
+    health = api.health(return_type='pandas')
+    print(health)   # prints Dataframe:         is_healthy
+                    #                       0         True
+
+    
     account_rewards = api.account_rewards(
         stake_address='stake1ux3g2c9dx2nhhehyrezyxpkstartcqmu9hk63qgfkccw5rqttygt7',
         count=20,
@@ -59,7 +69,7 @@ try:
     account_rewards = api.account_rewards(
         stake_address='stake1ux3g2c9dx2nhhehyrezyxpkstartcqmu9hk63qgfkccw5rqttygt7',
         count=20,
-        gather_pages=True,
+        gather_pages=True, # will collect all pages
     )
     print(account_rewards[0].epoch)  # prints 221
     print(len(account_rewards))  # prints 57

blockfrost/api/__init__.py

@@ -19,14 +19,15 @@ class RootResponse:
         version: str
 
     @object_request_wrapper(RootResponse)
-    def root(self):
+    def root(self, **kwargs):
         """
         Root endpoint has no other function than to point end users to documentation.
 
         https://docs.blockfrost.io/#tag/Health/paths/~1/get
-
-        :returns: RootResponse object.
-        :rtype: RootResponse
+        :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+        :type return_type: str
+        :returns RootResponse object.
+        :rtype RootResponse
         :raises ApiError: If API fails
         :raises Exception: If the API response is somehow malformed.
         """
@@ -60,6 +61,7 @@ def root(self):
         address, \
         address_total, \
         address_utxos, \
+        address_utxos_asset, \
         address_transactions
     from .cardano.assets import \
         assets, \
@@ -122,4 +124,7 @@ def root(self):
     from .cardano.scripts import \
         scripts, \
         script, \
-        script_redeemers
+        script_json, \
+        script_cbor, \
+        script_redeemers, \
+        script_datum

blockfrost/api/cardano/accounts.py

@@ -18,15 +18,17 @@ class AccountResponse:
 
 
 @object_request_wrapper(AccountResponse)
-def accounts(self, stake_address: str):
+def accounts(self, stake_address: str, **kwargs):
     """
     Obtain information about a specific networkStake account.
 
     https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}/get
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
-    :returns: AccountResponse object.
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
+    :returns AccountResponse object.
     :rtype: AccountResponse
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -53,6 +55,8 @@ def account_rewards(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -61,7 +65,7 @@ def account_rewards(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountRewardResponse objects.
+    :returns A list of AccountRewardResponse objects.
     :rtype: [AccountRewardResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -89,6 +93,8 @@ def account_history(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -97,8 +103,8 @@ def account_history(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountHistoryResponse objects.
-    :rtype: [AccountHistoryResponse]
+    :returns A list of AccountHistoryResponse objects.
+    :rtype [AccountHistoryResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
     """
@@ -126,6 +132,8 @@ def account_delegations(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -134,7 +142,7 @@ def account_delegations(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountDelegationResponse objects.
+    :returns A list of AccountDelegationResponse objects.
     :rtype: [AccountDelegationResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -161,6 +169,8 @@ def account_registrations(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -169,7 +179,7 @@ def account_registrations(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountRegistrationResponse objects.
+    :returns A list of AccountRegistrationResponse objects.
     :rtype: [AccountRegistrationResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -196,6 +206,8 @@ def account_withdrawals(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -204,7 +216,7 @@ def account_withdrawals(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountWithdrawalResponse objects.
+    :returns A list of AccountWithdrawalResponse objects.
     :rtype: [AccountWithdrawalResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -231,6 +243,8 @@ def account_mirs(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -239,7 +253,7 @@ def account_mirs(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountMIRSResponse objects.
+    :returns A list of AccountMIRSResponse objects.
     :rtype: [AccountMIRSResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -265,6 +279,8 @@ def account_addresses(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -273,7 +289,7 @@ def account_addresses(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountAddressResponse objects.
+    :returns A list of AccountAddressResponse objects.
     :rtype: [AccountAddressResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.
@@ -302,6 +318,8 @@ def account_addresses_assets(self, stake_address: str, **kwargs):
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
     :param gather_pages: Optional. Default: 100. Will collect all pages into one return
     :type gather_pages: bool
     :param count: Optional. Default: 1. The number of results displayed on one page.
@@ -310,7 +328,7 @@ def account_addresses_assets(self, stake_address: str, **kwargs):
     :type page: int
     :param order: Optional. "asc" or "desc". Default: "asc".
     :type order: str
-    :returns: A list of AccountAddressesAssetResponse objects.
+    :returns A list of AccountAddressesAssetResponse objects.
     :rtype: [AccountAddressesAssetResponse]
     :raises ApiError: If API fails
     :raises Exception: If the API response is somehow malformed.