Format code and add makefile

Author: cffls

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-ignore = D203, E126
+ignore = D203, E126, W503, E203
 exclude =
     .git,
     __pycache__,

Makefile

@@ -0,0 +1,74 @@
+.PHONY: clean clean-test clean-pyc clean-build format test help docs
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := poetry run python -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+cov: ## check code coverage
+	poetry run coverage run --source pycardano -m pytest
+	poetry run coverage report -m
+
+cov-html: cov ## check code coverage and generate an html report
+	poetry run coverage html -d cov_html
+	$(BROWSER) cov_html/index.html
+
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -f .coverage
+	rm -fr cov_html/
+	rm -fr .pytest_cache
+
+test: ## runs tests
+	poetry run pytest
+
+qa: ## runs static analysis with flake8
+	poetry run flake8 pycardano
+
+format: ## runs code style and formatter
+	poetry run isort .
+	poetry run black .
+
+docs: ## build the documentation
+	poetry run sphinx-build docs/source docs/build/html
+	$(BROWSER) docs/build/html/index.html
+
+release: clean qa test format ## build dist version and release to pypi
+	poetry build
+	poetry publish

README.md

@@ -178,48 +178,42 @@ Change directory into the repo, install all dependencies using poetry, and you a
 
 `cd pycardano && poetry install`
 
-#### Test
-
-PyCardano uses [pytest](https://docs.pytest.org/en/6.2.x/) for unit testing.
-
 When testing or running any program, it is recommended to enter 
 a [poetry shell](https://python-poetry.org/docs/cli/#shell) in which all python dependencies are automatically 
 configured: `poetry shell`.
 
-Run all tests:
-`pytest`
 
-Run all tests including doctests:
-`pytest --doctest-modules --ignore=examples`
+#### Test
+
+PyCardano uses [pytest](https://docs.pytest.org/en/6.2.x/) for unit testing.
+
+Run all tests:
+`make test`
 
 Run all tests in a specific test file:
-`pytest test/pycardano/test_transaction.py`
+`poetry run pytest test/pycardano/test_transaction.py`
 
 Run a specific test function:
-`pytest -k "test_transaction_body"`
+`poetry run pytest -k "test_transaction_body"`
 
 Run a specific test function in a test file:
-`pytest test/pycardano/test_transaction.py -k "test_transaction_body"`
+`poetry run pytest test/pycardano/test_transaction.py -k "test_transaction_body"`
 
 #### Test coverage
 
-Test coverage could be checked by running:
-`pytest --cov=pycardano --cov-config=.coveragerc`
-
-A coverage report visualized in html could be generated by running:
-`pytest --cov=pycardano --cov-config=.coveragerc --cov-report html:cov_html`  
-
-Run all possible tests (including doc tests) and generate html report and terminal report:
-`pytest --doctest-modules --ignore=examples --cov=pycardano --cov-config=.coveragerc --cov-report html:cov_html --cov-report term`
+We use [Coverage](https://coverage.readthedocs.io/en/latest/) to calculate the test coverage.
 
-The generated report will be in folder `./cov_html`.
+Test coverage could be generated by: `make cov`
+An html report could be generated and opened in browser by: `make cov-html`
 
 ### Style guidelines
 
 The package uses 
 [Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) docstring.
 
-The code style could be checked by [flake8](https://flake8.pycqa.org/en/latest/): `flake8 pycardano`
+Code could be formatted with command: `make format`
+
+The code style could be checked by [flake8](https://flake8.pycqa.org/en/latest/): `make qa`
 
 ### Docs generation
 
@@ -228,13 +222,9 @@ We use [sphinx](https://www.sphinx-doc.org/en/master/) with
 [Read the Docs theme](https://sphinx-rtd-theme.readthedocs.io/en/stable/) to generate the 
 html pages.
 
-Build htmls: 
-
-`cd docs && make html`
-
-Go to the main page: 
+Build docs and open the docs in browser: 
 
-`open build/html/index.html` 
+`make docs`
 
 
 

docs/source/conf.py

@@ -12,46 +12,43 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("../"))
 # For readthedocs whose working dir is at docs/source
-sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath("../../"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'PyCardano'
-copyright = '2021, JerryC'
-author = 'JerryC'
+project = "PyCardano"
+copyright = "2021, JerryC"
+author = "JerryC"
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx_rtd_theme'
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme"]
 
-master_doc = 'index'
+master_doc = "index"
 
 napoleon_google_docstring = True
 napoleon_include_init_with_doc = False
 
 autodoc_member_order = "bysource"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
-pygments_style = 'sphinx'
-highlight_language = 'python'
+pygments_style = "sphinx"
+highlight_language = "python"
 todo_include_todos = False
 
 
@@ -60,9 +57,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

examples/delegator_loyalty_rewards.py

@@ -3,7 +3,7 @@
 https://cardanoscan.io/transaction/c1b58dd4f2f4ee8656cc7962eefa8552877c4aa23d0699c02b885363d592a961
 """
 
-from blockfrost import BlockFrostApi, ApiUrls
+from blockfrost import ApiUrls, BlockFrostApi
 
 from pycardano import *
 
@@ -36,7 +36,9 @@
 
 # Derive an address from payment verification key
 input_address = Address(pvk.hash(), network=network)
-print(f"ADA will be distributed from this address: {input_address}, make sure there are enough ADA in it.")
+print(
+    f"ADA will be distributed from this address: {input_address}, make sure there are enough ADA in it."
+)
 
 # Create a BlockFrost chain context
 context = BlockFrostChainContext(BLOCK_FROST_PROJECT_ID, network)
@@ -73,16 +75,19 @@
 
 # ======= Business logic ends ========
 
-auxiliary_data = AuxiliaryData(AlonzoMetadata(metadata=Metadata({
-    674: {
-        "Title": f"Loyalty rewards for stake pool [{POOL_TICKER}] delegators",
-        "Rules": {
-            "100K+": "50 ADA",
-            "10K+": "10 ADA"
-        },
-        "Notes": "Created with https://github.com/cffls/pycardano."
-    }
-})))
+auxiliary_data = AuxiliaryData(
+    AlonzoMetadata(
+        metadata=Metadata(
+            {
+                674: {
+                    "Title": f"Loyalty rewards for stake pool [{POOL_TICKER}] delegators",
+                    "Rules": {"100K+": "50 ADA", "10K+": "10 ADA"},
+                    "Notes": "Created with https://github.com/cffls/pycardano.",
+                }
+            }
+        )
+    )
+)
 
 builder.auxiliary_data = auxiliary_data
 
@@ -95,8 +100,11 @@
 vk_witnesses = [VerificationKeyWitness(pvk, signature)]
 
 # Create final signed transaction
-signed_tx = Transaction(tx_body, TransactionWitnessSet(vkey_witnesses=vk_witnesses),
-                        auxiliary_data=auxiliary_data)
+signed_tx = Transaction(
+    tx_body,
+    TransactionWitnessSet(vkey_witnesses=vk_witnesses),
+    auxiliary_data=auxiliary_data,
+)
 
 # Submit signed transaction to the network
 print(signed_tx)

examples/native_token.py

@@ -14,7 +14,9 @@
 BLOCK_FROST_PROJECT_ID = "your_project_id"
 NETWORK = Network.TESTNET
 
-chain_context = BlockFrostChainContext(project_id=BLOCK_FROST_PROJECT_ID, network=NETWORK)
+chain_context = BlockFrostChainContext(
+    project_id=BLOCK_FROST_PROJECT_ID, network=NETWORK
+)
 
 """Preparation"""
 # Define the root directory where images and keys will be stored.
@@ -93,15 +95,14 @@ def load_or_create_key_pair(base_dir, base_name):
 """Define NFT (Alternative)"""
 # The nft definition above is somewhat verbose.
 # We can also directly create native assets from python primitives.
-my_nft_alternative = MultiAsset.from_primitive({
-    policy_id.payload:    # Use policy ID created from above. We can't use policy_id here because policy_id's type
-        {                 # is ScriptHash, which is not a primitive type. Instead, we use policy_id.payload (bytes)
-            b"MY_NFT_1":  # Name of our NFT1
-                1,        # Quantity of this NFT
-            b"MY_NFT_2":  # Name of our NFT2
-                1         # Quantity of this NFT
+my_nft_alternative = MultiAsset.from_primitive(
+    {
+        policy_id.payload: {  # Use policy ID created from above. We can't use policy_id here because policy_id's type  # is ScriptHash, which is not a primitive type. Instead, we use policy_id.payload (bytes)
+            b"MY_NFT_1": 1,  # Name of our NFT1  # Quantity of this NFT
+            b"MY_NFT_2": 1,  # Name of our NFT2  # Quantity of this NFT
         }
-})
+    }
+)
 
 # my_nft and my_nft_alternative are equivalent
 assert my_nft == my_nft_alternative
@@ -116,14 +117,14 @@ def load_or_create_key_pair(base_dir, base_name):
                 "description": "This is my first NFT thanks to PyCardano",
                 "name": "PyCardano NFT example token 1",
                 "id": 1,
-                "image": "ipfs://QmRhTTbUrPYEw3mJGGhQqQST9k86v1DPBiTTWJGKDJsVFw"
+                "image": "ipfs://QmRhTTbUrPYEw3mJGGhQqQST9k86v1DPBiTTWJGKDJsVFw",
             },
             "MY_NFT_2": {
                 "description": "This is my second NFT thanks to PyCardano",
                 "name": "PyCardano NFT example token 2",
                 "id": 2,
-                "image": "ipfs://QmRhTTbUrPYEw3mJGGhQqQST9k86v1DPBiTTWJGKDJsVFw"
-            }
+                "image": "ipfs://QmRhTTbUrPYEw3mJGGhQqQST9k86v1DPBiTTWJGKDJsVFw",
+            },
         }
     }
 }
@@ -170,19 +171,22 @@ def load_or_create_key_pair(base_dir, base_name):
 # Add verification keys and their signatures to the witness set
 vk_witnesses = [
     VerificationKeyWitness(payment_vkey, payment_signature),
-    VerificationKeyWitness(policy_vkey, policy_signature)
+    VerificationKeyWitness(policy_vkey, policy_signature),
 ]
 
 # We also need to add the policy script to witness set when we are minting new tokens
 native_script_witnesses = [policy]
 
 # Create final signed transaction
-signed_tx = Transaction(tx_body,
-                        TransactionWitnessSet(vkey_witnesses=vk_witnesses,
-                                              native_scripts=native_scripts),   # We also need to add the policy script
-                                                                                # to witness set when we are minting
-                                                                                # new tokens.
-                        auxiliary_data=auxiliary_data)
+signed_tx = Transaction(
+    tx_body,
+    TransactionWitnessSet(
+        vkey_witnesses=vk_witnesses, native_scripts=native_scripts
+    ),  # We also need to add the policy script
+    # to witness set when we are minting
+    # new tokens.
+    auxiliary_data=auxiliary_data,
+)
 
 print("############### Transaction created ###############")
 print(signed_tx)