Pip package for tutorial-vm

.github/workflows/build-and-publish-manual.yml

@@ -0,0 +1,57 @@
+name: Build and Publish Manual
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Google Cloud credentials
+        env:
+          GOOGLE_APPLICATION_CREDENTIALS: ${{ runner.temp }}/gcloud-key.json
+        run: |
+          echo "${{ secrets.GOOGLE_APPLICATION_CREDENTIALS_JSON }}" > $GOOGLE_APPLICATION_CREDENTIALS
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Get version from pyproject.toml
+        id: get_version
+        run: |
+          VERSION=$(grep -Po '(?<=^version = ")[^"]*' pyproject.toml)
+          echo "version=$VERSION" >> $GITHUB_ENV
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --editable .[dev]
+
+      - name: Build package 
+        run: |
+          python -m build
+          twine check dist/*
+
+      - name: Install package
+        run: |
+          pip install dist/*.whl
+
+      - name: Run tests
+        run: |
+          pytest tests/
+
+      - name: Clean up credentials
+        run: rm -f $GOOGLE_APPLICATION_CREDENTIALS
+
+      - name: Publish package
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TUTORIAL_PYPI_API_TOKEN }}
+        run: |
+          twine upload dist/*

.github/workflows/build-and-test-pip.yml

@@ -0,0 +1,46 @@
+name: Build and Test
+
+on:
+  pull_request:
+      types: [opened, synchronize, reopened]
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Google Cloud credentials
+      env:
+        GOOGLE_APPLICATION_CREDENTIALS: ${{ runner.temp }}/gcloud-key.json
+      run: |
+        echo "${{ secrets.GOOGLE_APPLICATION_CREDENTIALS_JSON }}" > $GOOGLE_APPLICATION_CREDENTIALS
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install --editable .[dev]
+
+    - name: Build package 
+      run: |
+        python -m build
+        twine check dist/*
+
+    - name: Install package
+      run: |
+        pip install dist/*.whl
+
+    - name: Run tests
+      run: |
+        pytest tests/
+
+    - name: Clean up credentials
+      run: rm -f $GOOGLE_APPLICATION_CREDENTIALS

environment.yml

@@ -7,4 +7,4 @@ dependencies:
     - python>=3.7
     - pip
     - pip:
-          - -e .
+          - -e .[dev]

pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "tutorial-vm"
+version = "0.0.1a0"
+authors = [
+    { name = "Liezl Maree", email = "[email protected]" },
+    { name = "Andrew Park", email = "[email protected]" },
+    { name = "Elizabeth Berrigan", email = "[email protected]" },
+]
+description = "Scripts for VM instances of tutorial platform."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.7"
+dependencies = [
+    "google-cloud-logging",
+    "google-cloud-pubsub",
+    "google-cloud-spanner==3.42.0",
+    "psutil",
+]
+keywords = [
+    "tutorial",
+    "vm",
+    "gcp",
+    "google-cloud",
+    "spanner",
+    "pubsub",
+    "logging",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 3 - Alpha",
+]
+
+[project.optional-dependencies]
+dev = ["toml", "twine", "build", "pytest", "black"]
+
+[project.urls]
+Homepage = "https://github.com/talmolab/tutorial_vm"
+Issues = "https://github.com/talmolab/tutorial_vm/issues"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["tutorial_vm"]
+
+[tool.pytest.ini_options]
+pythonpath = ["."]

tests/test_imports.py

@@ -0,0 +1,23 @@
+"""Module that tests the imports of the package."""
+
+
+def test_import():
+    import tutorial_vm
+
+    from tutorial_vm import crd_connect
+    from tutorial_vm import database
+    from tutorial_vm import logging_utils
+    from tutorial_vm import subscribe_instance
+    from tutorial_vm import update_inuse_status
+
+
+if __name__ == "__main__":
+
+    # Add the parent directory to the pythonpath (pytest setup to do this automatically)
+    import os
+    import sys
+
+    sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
+
+    # Run the test
+    test_import()

crd_connect.py → tutorial_vm/crd_connect.py

@@ -12,7 +12,7 @@
 import random
 import subprocess
 
-from logging_utils import CloudAndConsoleLogger
+from tutorial_vm.logging_utils import CloudAndConsoleLogger
 
 
 # Set up logging

database.py → tutorial_vm/database.py

@@ -8,7 +8,7 @@
 
 try:
     # This is used when running on a VM instance
-    from logging_utils import CloudAndConsoleLogger
+    from tutorial_vm.logging_utils import CloudAndConsoleLogger
 except ImportError:
     # This is used when running in the main application
     from vmassign import CloudAndConsoleLogger

subscribe_instance.py → tutorial_vm/subscribe_instance.py

@@ -9,9 +9,9 @@
 
 from google.cloud import pubsub_v1
 
-from crd_connect import connect_to_crd
-from database import SpannerDatabase
-from logging_utils import CloudAndConsoleLogger
+from tutorial_vm.crd_connect import connect_to_crd
+from tutorial_vm.database import SpannerDatabase
+from tutorial_vm.logging_utils import CloudAndConsoleLogger
 
 
 def create_parser():

update_inuse_status.py → tutorial_vm/update_inuse_status.py

@@ -13,8 +13,8 @@
     )
     raise e
 
-from database import SpannerDatabase
-from logging_utils import CloudAndConsoleLogger
+from tutorial_vm.database import SpannerDatabase
+from tutorial_vm.logging_utils import CloudAndConsoleLogger
 
 
 cnc_logger = CloudAndConsoleLogger(