chore: format changes with black, and google python docstring, install script testing

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+exclude=alembic/versions,.venv
+docstring-convention=google
+max-line-length = 88
+extend-ignore = ANN101

.github/ISSUE_TEMPLATE/bug_form.yml

@@ -21,9 +21,9 @@ body:
       label: To Reproduce
       description: What Operating System did you use and steps would we take to reproduce the behaviour?
       placeholder: "I use [macOS/Microsoft Windows].
-        Steps: 
-        1. Go to '...' 
-        2. Click on '....' 
+        Steps:
+        1. Go to '...'
+        2. Click on '....'
         3. Scroll down to '....' "
     validations:
       required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1 @@
-blank_issues_enabled: true
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/use_case.yml

@@ -36,10 +36,10 @@ body:
     attributes:
       label: Workflow
       description: How is the task accomplished? Please place each step on a new line.
-      placeholder: | 
+      placeholder: |
         1. Open Chrome
         2. Navigate to Google Flights
         3. Set the departure city
         4. ...
     validations:
-      required: true
+      required: true

.github/workflows/main.yml

@@ -7,7 +7,15 @@ on:
 
 jobs:
   run-ci:
-    runs-on: windows-latest
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+
+    strategy:
+      matrix:
+        # TODO: add windows matrix
+        os: [macos-latest]
 
     steps:
       - name: Checkout code
@@ -18,25 +26,32 @@ jobs:
         with:
           python-version: '3.10'
 
-      - name: Install dependencies
-        run: |
-          pip install wheel
-          pip install -r requirements.txt
-          pip install -e .
+      - name: Run tests using the shell script (macOS compatible).
+        if: matrix.os == 'macos-latest'
+        run: SKIP_POETRY_SHELL=1 sh install/install_openadapt.sh
 
-      - name: Check formatting with Black
-        run: |
-          black --check --exclude "(src|alembic)/" .
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - name: Run headless tests
-        uses: coactions/setup-xvfb@v1
+      - name: Install poetry
+        uses: snok/install-poetry@v1
         with:
-          run: python -m pytest
-          working-directory: ./  # Optional: Specify the working directory if needed
-          options:  # Optional: Add any additional options or arguments for pytest
+          version: 1.5.1
+          virtualenvs-create: true
+          virtualenvs-in-project: true
 
-      - name: flake8 Lint
-        uses: py-actions/flake8@v2
+      - name: Cache deps
+        id: cache-deps
+        uses: actions/cache@v2
         with:
-          plugins: "flake8-docstrings"
-          extra-args: "--docstring-convention=google --exclude=alembic/versions"
+          path: .venv
+          key: pydeps-${{ hashFiles('**/poetry.lock') }}
+
+      - run: poetry install --no-interaction --no-root
+        if: steps.cache-deps.outputs.cache-hit != 'true'
+
+      - name: Check formatting with Black
+        run: poetry run black --check .
+
+      - name: Run Flake8
+        run: poetry run flake8

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # How to contribute
 
-We would love to implement your contributions to this project! We simply ask that you observe the following guidelines.  
+We would love to implement your contributions to this project! We simply ask that you observe the following guidelines.
 
 ## Code Style
 
@@ -30,11 +30,11 @@ In order to effectively communicate any bugs or request new features, please sel
 ## Testing
 [GitHub Actions](https://github.com/MLDSAI/OpenAdapt/actions/new) are automatically run on each pull request to ensure consistent behavior and style. The Actions are composed of PyTest, [black](https://github.com/psf/black) and [flake8](https://flake8.pycqa.org/en/latest/user/index.html).
 
-You can run these tests on your own computer by downloading the dependencies using `poetry` (see [here](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/README.md#install)) and then running `pytest` in the root directory. 
+You can run these tests on your own computer by downloading the dependencies using `poetry` (see [here](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/README.md#install)) and then running `pytest` in the root directory.
 
 ## Pull Request Format
 
-To speed up the review process, please use the provided pull request template and create a draft pull request to get initial feedback. 
+To speed up the review process, please use the provided pull request template and create a draft pull request to get initial feedback.
 
 The pull request template includes areas to explain the changes, and a checklist with boxes for code style, testing, and documentation.
 

README.md

@@ -255,7 +255,7 @@ alembic revision --autogenerate -m "<msg>"
 
 ### Pre-commit Hooks
 
-To ensure code quality and consistency, OpenAdapt uses pre-commit hooks. These hooks 
+To ensure code quality and consistency, OpenAdapt uses pre-commit hooks. These hooks
 will be executed automatically before each commit to perform various checks and
 validations on your codebase.
 
@@ -269,7 +269,7 @@ The following pre-commit hooks are used in OpenAdapt:
 To set up the pre-commit hooks, follow these steps:
 
 1. Navigate to the root directory of your OpenAdapt repository.
- 
+
 2. Run the following command to install the hooks:
 
 ```

alembic/README

@@ -1 +1 @@
-Generic single-database configuration.
+Generic single-database configuration.

alembic/env.py

@@ -1,37 +1,39 @@
+"""Alembic Environment Configuration.
+
+This module provides the environment configuration for Alembic.
+"""
+
 from logging.config import fileConfig
 
-from sqlalchemy import engine_from_config
-from sqlalchemy import pool
+from sqlalchemy import engine_from_config, pool
 
 from alembic import context
+from openadapt.config import DB_URL
+from openadapt.db import Base
 
-# this is the Alembic Config object, which provides
+# This is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
 alembic_config = context.config
 
 # Interpret the config file for Python logging.
 # This line sets up loggers basically.
-if alembic_config .config_file_name is not None:
-    fileConfig(alembic_config .config_file_name)
+if alembic_config.config_file_name is not None:
+    fileConfig(alembic_config.config_file_name)
 
-# add your model's MetaData object here
+# Add your model's MetaData object here
 # for 'autogenerate' support
 # from myapp import mymodel
 # target_metadata = mymodel.Base.metadata
-from openadapt.config import DB_URL
-from openadapt.models import *
-from openadapt.db import Base
-
 target_metadata = Base.metadata
 
-# other values from the config, defined by the needs of env.py,
-# can be acquired:
-# my_important_option = config.get_main_option("my_important_option")
-# ... etc.
-
 
 def get_url() -> str:
-    print(f"{DB_URL=}")
+    """Get the database URL.
+
+    Returns:
+        str: The database URL.
+    """
+    print(f"DB_URL={DB_URL}")
     return DB_URL
 
 
@@ -40,14 +42,12 @@ def run_migrations_offline() -> None:
 
     This configures the context with just a URL
     and not an Engine, though an Engine is acceptable
-    here as well.  By skipping the Engine creation
+    here as well. By skipping the Engine creation,
     we don't even need a DBAPI to be available.
 
     Calls to context.execute() here emit the given string to the
     script output.
-
     """
-    # url = config.get_main_option("sqlalchemy.url")
     url = get_url()
     context.configure(
         url=url,
@@ -64,11 +64,10 @@ def run_migrations_offline() -> None:
 def run_migrations_online() -> None:
     """Run migrations in 'online' mode.
 
-    In this scenario we need to create an Engine
+    In this scenario, we need to create an Engine
     and associate a connection with the context.
-
     """
-    configuration = alembic_config .get_section(alembic_config .config_ini_section)
+    configuration = alembic_config.get_section(alembic_config.config_ini_section)
     configuration["sqlalchemy.url"] = get_url()
     connectable = engine_from_config(
         configuration=configuration,

install/install_openadapt.sh

@@ -22,7 +22,6 @@ Cleanup() {
 
 # Run a command and ensure it did not fail
 RunAndCheck() {
-
     if $1 ; then
         echo "Success: $2"
     else
@@ -97,12 +96,12 @@ if ! CheckCMDExists "brew"; then
 
     # Check the type of chip
     cpu=$(sysctl machdep.cpu.brand_string)
-        if [[ $cpu == *"Apple"* ]]; then
-            # Add brew to PATH
-            echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
-            eval "$(/opt/homebrew/bin/brew shellenv)"
-        fi
-    
+    if [[ $cpu == *"Apple"* ]]; then
+        # Add brew to PATH
+        echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
+        eval "$(/opt/homebrew/bin/brew shellenv)"
+    fi
+
     brewExists=$(CheckCMDExists "brew")
     if ! CheckCMDExists "brew"; then
         echo "Failed to download brew"
@@ -130,5 +129,7 @@ RunAndCheck "pip3.10 install poetry" "Install Poetry"
 RunAndCheck "poetry install" "Install Python dependencies"
 RunAndCheck "poetry run alembic upgrade head" "Update database"
 RunAndCheck "poetry run pytest" "Run tests"
-RunAndCheck "poetry shell" "Activate virtual environment"
+if [ -z "$SKIP_POETRY_SHELL" ]; then
+    RunAndCheck "poetry shell" "Activate virtual environment"
+fi
 echo OpenAdapt installed successfully!

openadapt/__init__.py

@@ -1 +1,5 @@
+"""OpenAdapt package.
+
+This package contains modules for the OpenAdapt project.
+"""
 __version__ = "0.5.1"

openadapt/app/__init__.py

@@ -1,3 +1,12 @@
+"""openadapt.app package.
+
+This package contains modules for the OpenAdapt application.
+
+Example usage:
+    from openadapt.app import run_app
+
+    run_app()
+"""
 from openadapt.app.main import run_app
 
 if __name__ == "__main__":

openadapt/app/build.py

@@ -1,6 +1,14 @@
+"""openadapt.app.build module.
+
+This module provides functionality for building the OpenAdapt application.
+
+Example usage:
+    python build.py
+"""
+
+from pathlib import Path
 import os
 import subprocess
-from pathlib import Path
 
 import nicegui
 
@@ -19,7 +27,8 @@
 
 subprocess.call(spec)
 
-# add import sys ; sys.setrecursionlimit(sys.getrecursionlimit() * 5) to line 2 of OpenAdapt.spec
+# add import sys ; sys.setrecursionlimit(sys.getrecursionlimit() * 5)
+#  to line 2 of OpenAdapt.spec
 with open("OpenAdapt.spec", "r+") as f:
     lines = f.readlines()
     lines[1] = "import sys ; sys.setrecursionlimit(sys.getrecursionlimit() * 5)\n"