Basic Project Setup + Migrating Code from PySDK PR #298

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+ignore = E501, W503

.github/workflows/build.yml

@@ -0,0 +1,78 @@
+name: "Build workflow"
+on:
+  pull_request:
+  push:
+    tags:
+      - v**
+    branches:
+      - main
+
+env:
+  SANDBOX_CONFIG: dev
+  SANDBOX_GENESIS: genesis/dev/genesis.json
+
+jobs:
+  build-test:
+    runs-on: ubuntu-20.04
+    container: python:${{ matrix.python }}
+    strategy:
+      matrix:
+        python: [ "3.8", "3.9", "3.10" ]
+    steps:
+      - run: python3 --version
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: pip, lint, and units
+        run: make build-and-test
+  run-integration-tests:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python: [ "3.8", "3.9", "3.10" ]
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "${{ matrix.python }}"
+      - name: Test Python version
+        run: |
+          installed="$(python --version)"
+          expected="${{ matrix.python }}"
+          echo $installed
+          [[ $installed =~ "Python ${expected}" ]] && echo "Configured Python" || (echo "Failed to configure Python" && exit 1)
+      - name: Install required os level applications
+        run: |
+          sudo apt update -y
+          sudo apt install -y curl git nodejs
+          sudo apt -y install ca-certificates curl gnupg lsb-release
+          sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+          sudo echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
+            $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          sudo apt update
+          sudo apt -y install docker-ce docker-ce-cli containerd.io
+      - name: Setup docker compose
+        run: |
+           sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+           sudo chmod +x /usr/local/bin/docker-compose
+           sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
+           docker-compose --version
+      - name: Check cache for Docker layers
+        uses: satackey/action-docker-layer-caching@v0.0.11
+        # Ignore the failure of a step and avoid terminating the job.
+        continue-on-error: true
+        with:
+          key: docker-layer-caching-${{ github.workflow }}-${{ hashFiles(env.SANDBOX_CONFIG, env.SANDBOX_GENESIS) }}-{hash}
+          restore-keys: docker-layer-caching-${{ github.workflow }}-${{ hashFiles(env.CONFIG, env.SANDBOX_GENESIS) }}-
+      - name: Create sandbox
+        uses: lucasvanmol/algorand-sandbox-action@v1
+        with:
+          config: ${{ env.SANDBOX_CONFIG }}
+      - name: Setup integration test environment
+        run: make pip-development unit-test
+      - name: Run integration tests
+        run: make gh-blackbox

.gitignore

@@ -1,3 +1,23 @@
+##### graviton specific ignores #####
+
+# Integration tests
+.sandbox
+sandbox
+
+# Comma Seperated Value reports
+*.csv
+
+# Emacs detritus
+*~
+
+# VS Code detritus
+.vscode
+
+# IDE
+.idea
+
+##### BEGIN: github recommends for Python #####
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -127,3 +147,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+##### END: github recommends for Python #####

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## Versioning Legend
+
+Versioning is in Animal Emoji Lexicographical Order (AELO). For example:
+
+1. 🦙 (Alpaca)
+2. 🐗 (Boar)
+3. 🐈 (Cat)
+
+... etc ...
+
+## Tagging Cheatsheet
+
+* create an annotated tag:
+  * `git tag -as 🦙 -m "productionize graviton" && git push origin 🦙`
+* get tag details:
+  * `git show 🦙`
+
+## 🦙 (Alpaca)
+
+### Added
+
+* Basic functionality

Makefile

@@ -0,0 +1,60 @@
+####### Universal ######
+
+pip:
+	pip install -e .
+
+pip-development: pip
+	pip install -e.[development]
+
+flake8:
+	flake8 graviton tests
+
+black:
+	black --check .
+
+lint: black flake8
+
+unit-test:
+	pytest -sv tests/unit
+
+build-and-test: pip-development lint unit-test
+
+blackbox-smoke-prefix:
+	echo "hello blackbox!"
+	pwd
+	ls -l
+	ls -l sandbox
+	cd sandbox && docker-compose ps
+
+integration-test:
+	pytest -sv tests/integration
+
+
+###### Local Only ######
+
+# assumes installations of pipx, build and tox via:
+# `pip install pipx; pipx install build; pipx install tox`
+local-project-build:
+	pyproject-build
+
+# assumes a symbolic link: sandbox -> /cloned/repo/algorand/sandbox
+local-sandbox-test:
+	./sandbox/sandbox test
+
+local-blackbox-smoke: blackbox-smoke-prefix local-sandbox-test
+
+local-blackbox: local-blackbox-smoke integration-test
+
+# assumes act is installed, e.g. via `brew install act`:
+local-gh-simulate:
+	act
+
+###### Github Actions Only ######
+
+gh-sandbox-test:
+	# relax exit code condition because indexer returns 500 when last-round = 0
+	script -e -c "bash -x ./sandbox/sandbox test" || echo "finished ./sandbox test"
+
+gh-blackbox-smoke: blackbox-smoke-prefix gh-sandbox-test
+
+gh-blackbox: gh-blackbox-smoke integration-test