Pip package for lablink-client

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

@@ -0,0 +1,77 @@
+name: Build and Test
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+    name: Build lablink-client
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - 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: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: lablink-client-dist
+        path: dist/
+        retention-days: 1
+
+  tests:
+    name: Test lablink-client
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Download artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: lablink-client-dist
+        path: dist/
+
+    - name: List files
+      run: |
+        ls dist/
+
+    - name: Install package from artifact
+      run: |
+        WHL=$(ls dist/*.whl)
+        pip install "$WHL[dev]"
+
+    - name: Print installed packages
+      run: |
+        pip list
+
+    - name: Run tests
+      run: |
+        pytest tests/

.github/workflows/publish-pip.yml

@@ -0,0 +1,36 @@
+name: Publish on Release
+# This workflow will only work if an artifact named "lablink-client-dist" is uploaded to the repository
+# Run this workflow after testing using the "build-and-test-pip.yml" workflow
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Download Package Artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: lablink-client-dist # Name of the artifact to download
+          path: package/ # Download the artifact to this path
+
+      - name: Verify Artifact Contents
+        run: |
+          ls package/
+
+      - name: Publish package
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TUTORIAL_PYPI_API_TOKEN }}
+        run: |
+          twine upload package/*

environment.yml

@@ -1,4 +1,4 @@
-name: vm
+name: lablink-client
 
 channels:
     - conda-forge
@@ -7,4 +7,4 @@ dependencies:
     - python>=3.7
     - pip
     - pip:
-          - -e .
+        - -e .[dev]

crd_connect.py → lablink_client/crd_connect.py

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

database.py → lablink_client/database.py

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

logging_utils.py → lablink_client/logging_utils.py

@@ -15,11 +15,21 @@ def __init__(self, module_name: str, level=logging.DEBUG, format=None):
         self.name = module_name
 
         format = format or "%(module)s[%(levelname)s]: %(message)s"
-        formatter = logging.Formatter(format, datefmt="%H:%M:%S")
+        self.formatter = logging.Formatter(format, datefmt="%H:%M:%S")
+        self.level = level
         self.console_logger = self.setup_console_logging(
-            level=level, formatter=formatter
-        )
-        self.cloud_logger = self.setup_cloud_logging(level=level, formatter=formatter)
+            level=self.level, formatter=self.formatter
+        )   
+        self._cloud_logger = None
+
+
+    @property
+    def cloud_logger(self):
+        if self._cloud_logger is None:
+            self._cloud_logger = self.setup_cloud_logging(
+                level=self.level, formatter=self.formatter
+            )
+        return self._cloud_logger
 
     def __getattr__(self, name):
         """Pass the log call to both the console and cloud loggers."""

subscribe_instance.py → lablink_client/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 lablink_client.crd_connect import connect_to_crd
+from lablink_client.database import SpannerDatabase
+from lablink_client.logging_utils import CloudAndConsoleLogger
 
 
 def create_parser():

update_inuse_status.py → lablink_client/update_inuse_status.py

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

pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "lablink-client"
+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 = ["."]
+include = ["lablink_client*"]
+
+[tool.pytest.ini_options]
+pythonpath = ["."]

tests/test_imports.py

@@ -0,0 +1,11 @@
+"""Module that tests the imports of the package."""
+
+
+def test_import():
+    import lablink_client
+
+    from lablink_client import crd_connect
+    from lablink_client import database
+    from lablink_client import logging_utils
+    from lablink_client import subscribe_instance
+    from lablink_client import update_inuse_status