15 tom eso api client library enhancements

.github/workflows/run-tests.yml

@@ -18,6 +18,22 @@ jobs:
     - name: Style Checks
       run: poetry run flake8 tom_* --exclude=*/migrations/* --max-line-length=120
 
+  check_migrations:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.12"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install "poetry>=2.0,<3.0"
+        poetry install
+    - name: Missing Migrations
+      run: |
+        poetry run python tom_eso/tests/check_migrations.py
+
   run_tests:
     runs-on: ubuntu-latest
     strategy:
@@ -35,4 +51,4 @@ jobs:
           python -m pip install poetry
           poetry install
       - name: Run tests
-        run: poetry run python -m unittest discover -v
+        run: poetry run python tom_eso/tests/run_tests.py

.gitignore

@@ -92,6 +92,9 @@ docs/_build/
 .vscode/
 *.code-workspace
 
+# emacs
+*~
+
 # PyBuilder
 target/
 

README.md

@@ -1,15 +1,24 @@
 # tom_eso
 European Southern Obervatory Facility modules for TOM Toolkit
 
+This module is designed mainly to facilitate getting Target and Observation data
+from your TOM to the ESO P2 Tool (without having to re-enter it). Submitting
+observations is still expected to be done through the P2 Tool itself.
+
+This facility is still in prototype stage and feature requests are welcome.
+Please let us know your use cases.
+
 ## Installation
 
-Install the module into your TOM environment:
+1. Install the module into your TOM environment:
 
-```shell
-pip install tom-eso
-```
+    ```shell
+    pip install tom-eso
+    ```
+
+You'll want to update your `pyproject.toml` or `requirements.txt` file as well.
 
-1. In your project `settings.py`, add `tom_eso` to your `INSTALLED_APPS` setting:
+2. In your project `settings.py`, add `tom_eso` to your `INSTALLED_APPS` setting:
 
     ```python
     INSTALLED_APPS = [
@@ -18,7 +27,7 @@ pip install tom-eso
     ]
     ```
 
-2. Add `tom_eso.eso.ESOFacility` to the `TOM_FACILITY_CLASSES` in your TOM's
+3. Add `tom_eso.eso.ESOFacility` to the `TOM_FACILITY_CLASSES` in your TOM's
 `settings.py`:
    ```python
     TOM_FACILITY_CLASSES = [
@@ -28,12 +37,24 @@ pip install tom-eso
     ]
    ```   
 
-## Configuration
+4. Create the ESOProfile tables in your database:
+
+    ```bash
+    $ ./manage.py migrate
+    ```
+
+
+## Configuration Options
+
+After installation, each user will have an `ESOProfile` card in their TOM user profile where they can
+enter their ESO P2 Tool `username` and `password` and set the ESO environment to `Demo`, `Production`,
+or `Production La Silla`.
 
-Include the following settings inside the `FACILITIES` dictionary inside `settings.py`:
+If a TOM admin wants to have a single default set of ESO credentials accessible by all of their TOM's users, they can 
+include the following to thier `settings.py`:
 
 ```python
-    FACILITIES = {
+FACILITIES = {
         ...
         # defaults set from ESO p2 API Tutorial
         # https://www.eso.org/sci/observing/phase2/p2intro/Phase2API/api--python-programming-tutorial.html
@@ -45,3 +66,4 @@ Include the following settings inside the `FACILITIES` dictionary inside `settin
         },
     }
 ```
+Note: The user specific credentials will always take precendence over these TOM-wide defaults.

pyproject.toml

@@ -1,21 +1,26 @@
-[tool.poetry]
+[project]
 name = "tom-eso"
 # this version is a placeholder: version supplied by poetry-dynamic-versioning
-version = "0.0.0"
 description = "TOM Toolkit Facility module for the European Southern Observatory telescopes"
-authors = ["Lindy Lindstrom <llindstrom@lco.global>"]
+authors = [
+    {name = "Lindy Lindstrom", email = "llindstrom@lco.global"}
+]
 license = "GPL-3.0-or-later"
 readme = "README.md"
 packages = [{include = "tom_eso"}]
+dynamic = ["version"]
+requires-python = ">=3.10,<3.13"
+dependencies = [
+    "tomtoolkit>=2.22.0,<3",
+    "p2api>=1,<2",
+    "phase1api>=0,<2",
+]
 
-[tool.poetry.dependencies]
-python = ">=3.9.0,<3.13"
-tomtoolkit = ">=2.22"
-p2api = "~1"
-phase1api = "~0"
+[tool.poetry]
+version = "0.0.0" # version supplied by poetry-dynamic-versioning
 
 [tool.poetry.group.lint.dependencies]
-flake8 = "~7.3"
+flake8 = ">=6.0,<7.4"
 
 [tool.poetry-dynamic-versioning]
 enable = true