v0.5.0 (beta): adds get_job_output_logfile and updates doc (#27)

API version 0.4.0

.env-template

@@ -3,6 +3,6 @@
 # - To expose:  export $(grep -v '^#' .env | xargs -0)
 #
 
-#OSPARC_API_URL=http://127.0.0.1:8000
-#OSPARC_API_KEY=replace-with-api-key
-#OSPARC_API_SECRET=replace-with-secret-key
+OSPARC_API_URL=http://127.0.0.1:8000
+OSPARC_API_KEY=replace-with-api-key
+OSPARC_API_SECRET=replace-with-secret-key

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,20 @@
 <!-- Common title prefixes/annotations:
-
-  WIP:
-  bugfix:
-  🏗️ maintenance:
-
-  (⚠️ devops)  = changes in devops config required before deploying
+PREFIX:
+
+  WIP: work in progress
+  🐛    Fix a bug.
+  ✨    Introduce new features.
+  ♻️     Refactor code.
+  🚑️    Critical hotfix.
+  ⚗️     Perform experiments.
+  ⬆️    Upgrade dependencies.
+  📝    Add or update documentation.
+  🗑️    Deprecate code that needs to be cleaned up.
+  ⚰️     Remove dead code.
+  🔥    Remove code or files.
+  🔨    Add or update development scripts.
+
+or from https://gitmoji.dev/ 
 -->
 
 ## What do these changes do?
@@ -31,17 +41,12 @@ e.g.
 
 ## Checklist
 
-- [ ] ``test/test_workflows.py`` runs against fake server
-- [ ] Is [``api/openapi.json``](./api/openapi.json) up-to-date
-- [ ] Auto-doc generated 
-- [ ] Links to notebooks modified
+- [ ] Update [``api/openapi.json``](./api/openapi.json)
+- [ ] Update code
+- [ ] Update doc
+- [ ] Follow NOTES.md](./NOTES.md)
 
 <!-- This is YOUR section
 
 Add here YOUR checklist/notes to guide and monitor the progress of the case!
-
-e.g.
-- [ ] Runs in the swarm
-- [ ] Documentation reflects the changes
-- [ ] New module? Add your github username to [.github/CODEOWNERS](.github/CODEOWNERS)
 -->

.github/workflows/build-n-publish.yml

@@ -0,0 +1,52 @@
+#
+# SEE https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+#
+name: build-n-publish
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+      - staging_[a-zA-Z]+[0-9]+
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up latest Python 3
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Upgrade package tools
+        run: >-
+          python -m pip install -U
+          pip
+          setuptools
+          wheel
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+      - name: Publish distribution 📦 to *Test* PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.TEST_PYPI_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+          verbose: true
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/test.yml

@@ -1,6 +1,6 @@
 name: test
 
-on: 
+on:
   push:
     paths-ignore:
       - "*.md"
@@ -23,24 +23,24 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Pip cache
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-{{ matrix.python-version }}
-        restore-keys: |
-          ${{ runner.os }}-pip
-    - name: Install and Test
-      run: |
-        pip install --upgrade nox
-        nox -s test-${{ matrix.python-version }}
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Pip cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-{{ matrix.python-version }}
+          restore-keys: |
+            ${{ runner.os }}-pip
+      - name: Install and Test
+        run: |
+          pip install --upgrade nox
+          nox -s test-${{ matrix.python-version }}
     # TODO: add coverage
     # - name: Upload coverage report
     #   uses: codecov/codecov-action@v1