initial commit

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI Python
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  tests-cpu:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.8, 3.9]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Create venv
+      run: python3 -m venv venv
+    - name: Install dependencies
+      run: venv/bin/python -m pip install -e .[dev]
+    - name: Run Tests
+      run: venv/bin/pytest -v test/

.github/workflows/format.yml

@@ -0,0 +1,40 @@
+name: Code Format
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  mypy:
+    runs-on: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Create venv
+      run: python3 -m venv venv
+    - name: Install dependencies
+      run: venv/bin/python -m pip install -e .[dev]
+    - name: Run mypy
+      run: venv/bin/mypy --no-strict-optional
+
+  pre-commit-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+
+      - name: set PY
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - uses: pre-commit/[email protected]
+        # this action also provides an additional behaviour when used in private repositories
+        # when configured with a github token, the action will push back fixes to the pull request branch
+        # with:
+        #   token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# setup.cfg created
+*.md5sum

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+    - id: black
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        exclude: \.tftpl$
+      - id: check-yaml
+      - id: check-json
+        exclude: '^.vscode/'
+
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.8.2
+    hooks:
+      - id: reorder-python-imports
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list
+          - "ans,hist"
+          - --skip
+          - "*.bib,*.ipynb,*.lock"
+
+  - repo: https://github.com/myint/docformatter
+    rev: v1.5.0
+    hooks:
+      - id: docformatter
+        args: [--in-place, --wrap-summaries=115, --wrap-descriptions=120]

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/main.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.envFile": "${workspaceFolder}/venv",
+    "python.testing.pytestArgs": [],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

README.md

@@ -0,0 +1,9 @@
+# amiga-app-template
+
+This repository is designed to streamline the creation of a new application deployable to the Amiga brain.
+
+For the most up-to-date documentation on using this template repository, please refer to:
+
+[amiga.farm-ng.com - **Developing Custom Applications**](https://amiga.farm-ng.com/docs/brain/brain-apps)
+
+---

bootstrap.sh

@@ -0,0 +1,53 @@
+#!/bin/bash -ex
+# Helper script to bootstrap Farm_ng's app venv directories
+
+
+bootstrap() {
+    local application="${1}"
+    local venv="${2:-venv}"
+    local bin="${venv}/bin/activate"
+
+    # Run apt install if required.
+    # You must inspect for errors in the override script at this time.
+    if [[ -f ${application}/apt_requirements.txt ]]
+    then
+        f_size=$(wc -c <"${application}/apt_requirements.txt")
+        if [f_size -ge 1 ]
+        then
+            xargs sudo apt install -y <${application}/apt_requirements.txt || true
+        fi
+    fi
+    PYTHON=${venv}/bin/python
+
+    if [[ -f ${application}/setup.cfg.md5sum ]]
+    then
+        old_checksum=$(cat ${application}/setup.cfg.md5sum)
+        new_checksum=$(md5sum ${application}/setup.cfg)
+        if [ "$new_checksum" == "$old_checksum" ]
+        then
+            echo "Not updating venv"
+        else
+            rm ${venv}/.lock || true
+            echo "setup.cfg md5sum changed, will update venv"
+        fi
+    fi
+
+    if [ ! -f ${venv}/.lock ]; then
+        echo "creating venv ${venv}"
+        python3 -m venv ${venv}
+        # Upgrade Pip
+        $PYTHON -m pip install --upgrade pip
+        $PYTHON -m pip install setuptools wheel
+        cd ${application}
+        $PYTHON -m pip install -e .
+        touch ${venv}/.lock
+        md5sum ${application}/setup.cfg > ${application}/setup.cfg.md5sum
+
+    else
+        echo "${venv} already existed, launching application"
+    fi
+
+
+}
+
+bootstrap $1 $2

entry.sh

@@ -0,0 +1,8 @@
+#!/bin/bash -ex
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+$DIR/bootstrap.sh $DIR $DIR/venv
+
+$DIR/venv/bin/python $DIR/src/main.py $@
+
+exit 0

install.sh

@@ -0,0 +1,8 @@
+#! /bin/bash
+
+set -uxeo pipefail
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+rm -f ~/manifest.json
+ln -s "$DIR/manifest.json" ~/manifest.json

libs/amiga_package/__init__.py

@@ -0,0 +1,22 @@
+# Copyright (c) farm-ng, inc.
+#
+# Licensed under the Amiga Development Kit License (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://github.com/farm-ng/amiga-dev-kit/blob/main/LICENSE
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# Version variable
+import sys
+
+if sys.version_info >= (3, 8):  # pragma: >=3.8 cover
+    import importlib.metadata as importlib_metadata
+else:  # pragma: <3.8 cover
+    import importlib_metadata
+
+__version__ = importlib_metadata.version(__name__)

libs/amiga_package/ops.py

@@ -0,0 +1,8 @@
+"""Template module with math functions."""
+
+
+def add(a: int, b: int) -> int:
+    """Template function to add to integer values."""
+    assert isinstance(a, int), f"not an integer. Got: {type(a)}"
+    assert type(a) == type(b), f"Type of 'b' must be equal. Got: {type(b)}"
+    return a + b