v0.6.0 Release

.gitignore

@@ -137,3 +137,8 @@ dmypy.json
 # Pyre type checker
 .pyre/
 /tests/data/reports/
+/tests/data/test_default_pipeline_name_objs_summary.yaml
+/tests/data/test_default_pipeline_name_stats_summary.tsv
+/tests/data/test_file_links/link_results/
+/tests/data/default_pipeline_name_objs_summary.yaml
+/tests/data/default_pipeline_name_stats_summary.tsv

MANIFEST.in

@@ -2,4 +2,7 @@ include requirements/*
 include README.md
 include pipestat/schemas/*
 include pipestat/backends/*
+include pipestat/backends/file_backend/*
+include pipestat/backends/db_backend/*
+include pipestat/pipestatreader/*
 include pipestat/jinja_templates/*

README.md

@@ -18,7 +18,6 @@ First you need a local demo instance of posgres running to test the database bac
 
 ```
 docker run --rm -it -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=pipestat-password -e POSTGRES_DB=pipestat-test -p 5432:5432 postgres
-
 ```
 
 Then, run tests:

docs/README.md

@@ -25,9 +25,8 @@ pip install pipestat
 
 ```console
 export PIPESTAT_RESULTS_SCHEMA=output_schema.yaml
-export PIPESTAT_SAMPLE_NAME=my_record
+export PIPESTAT_RECORD_IDENTIFIER=my_record
 export PIPESTAT_RESULTS_FILE=results_file.yaml
-export PIPESTAT_PROJECT_NAME=my_namespace
 ```
 Note: When setting environment variables as in the above example, you will need to provide an output_schema.yaml file in your current working directory with the following example data:
 ```
@@ -37,6 +36,7 @@ result_name:
 ```
 
 ## Pipeline results reporting and retrieval
+### For these examples below, it is assumed that the proper environment variables (see above) have been set.
 
 ### Report a result
 
@@ -60,7 +60,7 @@ psm.report(values={"result_name": 1.1})
 From command line:
 
 ```console
-pipestat retrieve -i result_name
+pipestat retrieve -r my_record
 ```
 
 From Python:
@@ -69,7 +69,7 @@ From Python:
 import pipestat
 
 psm = pipestat.PipestatManager()
-psm.retrieve(result_identifier="result_name")
+psm.retrieve_one(result_identifier="result_name")
 ```
 
 ## Pipeline status management