merge main, untested

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest a a fearture or improvement for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+
+**Note: this issue will be converted to a Discussion under [ideas](../discussions/categories/ideas)**
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install flake8 black textX==3.0.0 requests py-algorand-sdk==1.18.0
+          pip install flake8 black==23.1.0 textX==3.0.0 requests py-algorand-sdk==1.18.0
 
       - name: Run flake8
         run: flake8 ${{ github.workspace }} --ignore=E501,F403,F405,E126,E121,W503,E203

.pre-commit-config.yaml

@@ -5,8 +5,6 @@ repos:
     -   id: flake8
 
   - repo: https://github.com/psf/black
-    rev: 22.8.0
+    rev: 23.1.0
     hooks:
       - id: black
-        args: ['.', '--check']
-        exclude: ^(env|venv)

.prettierignore

@@ -0,0 +1 @@
+*.html

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .

docs/_static/alabaster.css_t

@@ -0,0 +1 @@
+/* This file intentionally left blank. */

docs/_static/css/code-block.css

@@ -0,0 +1,51 @@
+.notranslate {
+  margin: 24px 0;
+
+  color: #000000;
+
+  font-family: "JetBrains Mono", monospace;
+  font-size: 14px;
+  line-height: 18px;
+}
+
+.block .literal.notranslate {
+  display: block;
+
+  width: 100%;
+
+  padding: 20px 24px;
+
+  border-radius: 8px;
+}
+
+.literal.notranslate {
+  padding: 2px 4px;
+
+  background: rgba(0, 0, 0, 0.09);
+  border-radius: 2px;
+}
+
+.highlight-default.notranslate {
+  margin-bottom: 40px;
+}
+
+.highlight {
+  overflow: auto;
+
+  padding: 24px;
+
+  background-color: #f5f5f5;
+  border-radius: 8px;
+}
+
+.index-page .highlight {
+  background-color: #000000;
+}
+
+.highlight .linenos {
+  background: none;
+}
+
+.highlight .err {
+  background: none;
+}

docs/_static/css/custom-sidebar.css

@@ -0,0 +1,66 @@
+.sphinxsidebar {
+  position: relative;
+  z-index: 1;
+}
+
+.sphinxsidebarwrapper,
+.sidebar-container {
+  height: 100%;
+}
+
+.index-page .sidebar-sticky-content {
+  margin-top: 375px;
+}
+
+.logo-link {
+  display: block;
+
+  margin: 0 0 72px;
+}
+
+.logo {
+  width: 140px;
+}
+
+.logo-green {
+  display: none;
+}
+
+.index-page .logo-green {
+  display: block;
+}
+
+.index-page .logo-white {
+  display: none;
+}
+
+.toctree-l1.current a.current {
+  font-weight: 600;
+}
+
+ul .toctree-l2 {
+  margin-bottom: 8px;
+
+  line-height: 24px;
+}
+
+.social-links {
+  margin-top: 64px;
+}
+
+.social-links .social-link {
+  color: rgba(0, 0, 0, 0.7);
+
+  font-size: 16px;
+}
+
+.social-link .social-link__anchor,
+.social-link .social-link__anchor:hover,
+.social-link .social-link__anchor:active {
+  color: inherit;
+}
+
+.social-links .social-link:hover,
+.social-link .social-link__anchor:focus {
+  color: #000000;
+}

docs/_static/css/custom.css

@@ -0,0 +1,179 @@
+.index-page body {
+  background-color: #20e2bf;
+}
+
+.index-page .homepage-tealish-cannister {
+  display: block;
+}
+
+.menu-open body,
+.menu-open .bodywrapper .body {
+  overflow: hidden;
+}
+
+a.headerlink {
+  position: absolute;
+  bottom: -1px;
+
+  margin-left: 8px;
+
+  visibility: hidden;
+
+  font-size: 0.6em;
+}
+
+a.headerlink,
+a.headerlink:active,
+a.headerlink:visited {
+  color: #666666;
+}
+
+a.headerlink:hover {
+  color: #000000;
+}
+
+h1 a.headerlink {
+  bottom: -8px;
+
+  margin-left: 16px;
+
+  font-size: 0.4em;
+}
+
+h3 a.headerlink {
+  bottom: 0;
+
+  margin-left: 6px;
+
+  font-size: 0.8em;
+}
+
+h1:hover a.headerlink,
+h2:hover a.headerlink,
+h3:hover a.headerlink,
+a.headerlink:focus {
+  visibility: visible;
+}
+
+.document {
+  position: relative;
+  z-index: 1;
+}
+
+.sticky {
+  position: sticky;
+  top: 41px;
+}
+
+.documentwrapper {
+  display: grid;
+  justify-content: space-between;
+  grid-template-columns: 220px 1fr 220px;
+  gap: 24px;
+
+  padding: 45px 48px 0;
+}
+
+.bodywrapper {
+  width: 100%;
+  max-width: 720px;
+  margin: 0 auto;
+}
+
+.bodywrapper .body {
+  position: relative;
+
+  margin: 68px auto 0;
+}
+
+.index-page .bodywrapper .body {
+  margin-top: 375px;
+}
+
+.homepage-tealish-cannister {
+  position: absolute;
+  top: 0;
+  left: 50%;
+  z-index: 0;
+  transform: translateX(-50%);
+
+  display: none;
+}
+
+.homepage-tealish-cannister img {
+  width: 860px;
+}
+
+.copyright {
+  margin: 39px 0 96px;
+}
+
+.admonition {
+  margin-bottom: 40px;
+
+  padding: 24px;
+
+  color: #24292e;
+  background: #f5f5f5;
+  border-radius: 8px;
+
+  font-size: 16px;
+  line-height: 140%;
+}
+
+.admonition p {
+  margin-bottom: 16px;
+}
+
+.admonition p:last-of-type {
+  margin-bottom: 0;
+}
+
+.admonition-title {
+  margin-bottom: 24px;
+
+  font-size: 24px;
+}
+
+.index-page-content-links {
+  margin: 36px 0;
+  list-style: none;
+}
+
+.index-page-content-links li {
+  border-bottom: 1px solid #000000;
+}
+
+.index-page-content-links li:first-of-type {
+  border-top: 1px solid #000000;
+}
+
+.index-page-content-links li p {
+  margin: 0;
+}
+
+.index-page-content-links a {
+  display: block;
+
+  width: 100%;
+
+  padding: 24px 0;
+
+  font-family: "tiny", monospace;
+  font-size: 36px;
+  font-weight: 400;
+  line-height: 80%;
+  letter-spacing: -0.03em;
+}
+
+.index-page-content-links a::before {
+  content: "→";
+
+  display: inline-block;
+
+  margin-right: 8px;
+}
+
+.sig {
+  font-family: "JetBrains Mono", monospace;
+}