Package3

.github/workflows/python.yml

@@ -0,0 +1,35 @@
+# https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-python
+
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install black flake8 pytest mypy
+        if [ -f requirements-test.txt ]; then pip install -r requirements-test.txt; fi
+    - name: Lint with black
+      run: |
+        black . --diff --check
+    - name: Lint with flake8
+      run: |
+        flake8 hermit --count --statistics
+    - name: Test with pytest
+      run: |
+        # pytest --cov=hermit --cov-config=test/.coveragerc --ignore=vendor
+        echo "FIXME"

.gitignore

@@ -12,4 +12,5 @@ dist
 build.info
 .coverage
 .mypy_cache/
-docs/_build
+docs/_build
+.DS_Store

.travis.yml

@@ -7,8 +7,12 @@ before_install:
 install:
   - pip install wheel
   - pip install codecov
-  - pip install -r requirements.frozen.txt
+  - pip install -r requirements.txt
 script:
   - python -m pytest --cov=hermit --cov-config=tests/.coveragerc --ignore=vendor
+  - python -m black hermit tests scripts *.py
+  - python -m flake8 hermit tests scripts *.py
+  - python -m mypy -p hermit
+  - python -m sphinx -c docs hermit docs/_build
 after_success:
   - codecov

Jenkinsfile

@@ -19,8 +19,9 @@ pipeline {
         sh '''
           . .virtualenv/bin/activate
           python setup.py install
-          make lint
-          make test 
+          make check
+          make test
+          make docs
         '''
       }
     }
@@ -32,12 +33,10 @@ pipeline {
         withCredentials([usernamePassword(credentialsId: 'tbd', passwordVarable: 'PYPI_PASSWORD', usernameVariable: 'PYPI_USERNAME')]) {
           sh '''
             . ./environment.sh
-            make upload
+            make release
           '''
         }
       }
     }
   }
 }
-
-

Makefile

@@ -1,40 +1,47 @@
 #
-# == Paths & Directories ==
+# == Environment ==
 #
 
-VENV_DIR := .virtualenv
-
-PYTHON3                    := $(shell command -v python3 2> /dev/null)
-PYTHON_REQUIREMENTS        := requirements.txt
-PYTHON_FROZEN_REQUIREMENTS := requirements.frozen.txt
+UNAME := $(shell uname)
 
 #
-# == Configuration ==
+# == Files & Directories ==
 #
 
-UNAME := $(shell uname)
+PYTHON_REQUIREMENTS := requirements.in
+PYTHON_FROZEN_REQUIREMENTS := requirements.txt
+
+VENV_DIR := .virtualenv
+FIXTURES := tests/fixtures
+SCRIPTS := scripts
+EXAMPLES := examples
 
 #
 # == Commands ==
 #
 
-PIP        := $(VENV_DIR)/bin/pip
-PYTEST     := $(VENV_DIR)/bin/pytest
-FLAKE8     := $(VENV_DIR)/bin/flake8
-MYPY       := $(VENV_DIR)/bin/mypy
-SPHINX_BUILD := $(VENV_DIR)/bin/sphinx-build
+CAT := cat
+ECHO := echo
 
-#
-# == Targets ==
-#
+BREW := brew
+APT := apt
 
-default: dependencies
+SYSTEM_PYTHON3 := $(shell command -v python3 2> /dev/null)
+PYTHON3 := $(VENV_DIR)/bin/python3
+PIP := $(VENV_DIR)/bin/pip
 
-docs:
-	$(SPHINX_BUILD) -c docs hermit docs/_build
+PYTEST := $(VENV_DIR)/bin/pytest
+BLACK := $(VENV_DIR)/bin/black
+FLAKE8 := $(VENV_DIR)/bin/flake8
+MYPY := $(VENV_DIR)/bin/mypy
+SPHINX_BUILD := $(VENV_DIR)/bin/sphinx-build
+TWINE := twine
 
-clean:
-	$(RM) -rf docs/_build/* build/* dist/* hermit.egg-info build.info
+default: dependencies
+
+#
+# == Dependencies ==
+#
 
 freeze:
 	$(PIP) freeze -l > $(PYTHON_FROZEN_REQUIREMENTS)
@@ -43,12 +50,13 @@ dependencies: system-dependencies python-dependencies
 
 system-dependencies:
 ifeq ($(UNAME),Darwin)
-	brew ls --versions zbar || brew install zbar
+	$(BREW) ls --versions zbar || brew install zbar
 else
-	sudo apt install libzbar0
+	$(APT) install libzbar0
 endif
 
 python-dependencies: $(VENV_DIR)
+	$(PYTHON3) -m pip install --upgrade pip
 	$(PIP) install wheel
 ifdef UNFREEZE
 	 $(PIP) install -r $(PYTHON_REQUIREMENTS)
@@ -57,24 +65,65 @@ else
 endif
 
 
+$(VENV_DIR):
+	$(SYSTEM_PYTHON3) -m venv --prompt='hermit' $(VENV_DIR)
+
+#
+# == Development ==
+#
+
+check:
+	$(BLACK) --check hermit tests scripts *.py
+	$(FLAKE8) hermit tests scripts *.py
+	$(MYPY) -p hermit
+
+test:
+	$(PYTEST) --cov=hermit --cov-config=tests/.coveragerc --ignore=vendor
+
+docs:
+	HERMIT_LOAD_ALL_IO=true $(SPHINX_BUILD) -c docs hermit docs/_build
+
+#
+# == Examples & Fixtures ==
+#
+
+fixtures: $(FIXTURES)/signature_requests/2-of-2.p2sh.testnet.coordinator_signed.gif $(FIXTURES)/signature_requests/2-of-2.p2sh.testnet.gif $(EXAMPLES)/lorem_ipsum.gif $(EXAMPLES)/hello_world.jpg
+
+$(EXAMPLES)/lorem_ipsum.gif: $(FIXTURES)/lorem_ipsum.txt
+	$(CAT) $< | $(PYTHON3) $(SCRIPTS)/create_qr_code_animation.py $@
+
+$(EXAMPLES)/hello_world.jpg: $(FIXTURES)/hello_world.txt
+	$(CAT) $< | $(PYTHON3) scripts/create_qr_code_image.py $@
+
+%.gif: %.psbt
+	$(CAT) $< | $(PYTHON3) $(SCRIPTS)/create_qr_code_animation.py $@ true
+
+%.coordinator_signed.psbt: %.psbt
+	$(CAT) $< | $(PYTHON3) $(SCRIPTS)/sign_psbt_as_coordinator.py $(FIXTURES)/coordinator.pem > $@
+
+
+#
+# == Release ==
+#
+
 build.info:
-	echo ${BUILD_NUMBER} > build.info
+	$(ECHO) ${BUILD_NUMBER} > build.info
 
 package: python-dependencies build.info
-	python setup.py sdist bdist_wheel
+	$(PYTHON3) setup.py sdist bdist_wheel
 
-upload: python-dependencies package
-	#twine upload -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --repository-url https://test.pypi.org/legacy/ dist/*
-	twine upload dist/*
+release: package
+	#$(TWINE) upload -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --repository-url https://test.pypi.org/legacy/ dist/*
+	$(TWINE) upload dist/*
 
-$(VENV_DIR):
-	$(PYTHON3) -m venv --prompt='hermit' $(VENV_DIR)
+.PHONY: docs
 
-test:
-	$(PYTEST) --cov=hermit --cov-config=tests/.coveragerc --ignore=vendor
+#
+# == Cleanup ==
+#
 
-lint:
-	-$(FLAKE8) hermit --exclude=__init__.py
-	-$(MYPY) hermit/
+clean:
+	$(RM) -rf docs/_build/* build/* dist/* hermit.egg-info build.info /tmp/shard_words.bson*
 
-.PHONY: test docs
+purge:
+	$(RM) -rf $(VENV_DIR)