Merge pull request #6 from pepkit/orm

v0.1.0

.github/workflows/run-pytest.yml

@@ -2,15 +2,15 @@ name: Run pytests
 
 on:
   push:
-    branches: [master, dev]
+    branches: [master]
   pull_request:
-    branches: [master, dev]
+    branches: [master]
 
 jobs:
   pytest:
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.6, 3.9]
         os: [ubuntu-latest] # can't use macOS when using service containers or container jobs
     runs-on: ${{ matrix.os }}
     services:
@@ -47,4 +47,4 @@ jobs:
       uses: codecov/codecov-action@v1
       with:
         file: ./coverage.xml
-        name: py-${{ matrix.python-version }}-${{ matrix.os }}
+        name: py-${{ matrix.python-version }}-${{ matrix.os }}

.gitignore

@@ -7,6 +7,7 @@ __pycache__
 *.py[cod]
 *$py.class
 __pycache__/
+.vscode/
 
 # C extensions
 *.so

.pre-commit-config.yaml

@@ -1,21 +1,21 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.0.1
     hooks:
       - id: trailing-whitespace
       - id: check-yaml
-      - id: check-json
       - id: end-of-file-fixer
-      - id: name-tests-test
       - id: requirements-txt-fixer
       - id: trailing-whitespace
-
-  - repo: https://github.com/psf/black
-    rev: 20.8b1
-    hooks:
-      - id: black
+      - id: check-ast
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.7.0
+    rev: 5.9.1
     hooks:
       - id: isort
+        args: ["--profile", "black"]
+
+  - repo: https://github.com/psf/black
+    rev: 21.6b0
+    hooks:
+      - id: black

MANIFEST.in

@@ -1,3 +1,3 @@
 include requirements/*
 include README.md
-include pipestat/schemas/*
+include pipestat/schemas/*

README.md

@@ -30,7 +30,9 @@ export PIPESTAT_RESULTS_FILE=results_file.yaml
 export PIPESTAT_NAMESPACE=my_namespace
 ```
 
-## Report a result
+## Pipeline results reporting and retrieval
+
+### Report a result
 
 From command line:
 
@@ -46,8 +48,8 @@ import pipestat
 psm = pipestat.PipestatManager()
 psm.report(values={"result_name": 1.1})
 ```
- 
-## Retrieve a result
+
+### Retrieve a result
 
 From command line:
 
@@ -63,5 +65,39 @@ import pipestat
 psm = pipestat.PipestatManager()
 psm.retrieve(result_identifier="result_name")
 ```
-
 
+## Pipeline status management
+
+## Set status
+
+From command line:
+
+```console
+pipestat status set running
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.set_status(status_identifier="running")
+```
+
+## Get status
+
+From command line:
+
+```console
+pipestat status get
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.get_status()
+```

codecov.yml

@@ -2,4 +2,4 @@ ignore:
   - "*/argparser.py"
   - "*/cli.py"
   - "*/__main__.py"
-  - "setup.py"
+  - "setup.py"

docs/README.md

@@ -30,7 +30,9 @@ export PIPESTAT_RESULTS_FILE=results_file.yaml
 export PIPESTAT_NAMESPACE=my_namespace
 ```
 
-## Report a result
+## Pipeline results reporting and retrieval
+
+### Report a result
 
 From command line:
 
@@ -46,8 +48,8 @@ import pipestat
 psm = pipestat.PipestatManager()
 psm.report(values={"result_name": 1.1})
 ```
- 
-## Retrieve a result
+
+### Retrieve a result
 
 From command line:
 
@@ -63,5 +65,39 @@ import pipestat
 psm = pipestat.PipestatManager()
 psm.retrieve(result_identifier="result_name")
 ```
-
 
+## Pipeline status management
+
+## Set status
+
+From command line:
+
+```console
+pipestat status set running
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.set_status(status_identifier="running")
+```
+
+## Get status
+
+From command line:
+
+```console
+pipestat status get
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.get_status()
+```