diff --git a/docs/pipestat/changelog.md b/docs/pipestat/changelog.md index eb4eb621..d336e38b 100644 --- a/docs/pipestat/changelog.md +++ b/docs/pipestat/changelog.md @@ -2,6 +2,16 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. +## [0.10.0] - 2024-07-18 +### Fixed +- allow for bool or boolean in schema [#189](https://github.com/pepkit/pipestat/issues/189) +- fix pipestat summarize bugs re: inaccurate paths [#190](https://github.com/pepkit/pipestat/issues/190) +- add support for sqlite dbbackend [#192](https://github.com/pepkit/pipestat/issues/192) + +## Added +- pephub backend [#125](https://github.com/pepkit/pipestat/issues/125) + + ## [0.9.2] - 2024-06-24 ### Changed - User can override pipeline name via parameter or config file, otherwise look at output_schema, then fall back on default as last resort. diff --git a/docs/pipestat/configuration.md b/docs/pipestat/configuration.md index ad5f0b9d..d7ad2952 100644 --- a/docs/pipestat/configuration.md +++ b/docs/pipestat/configuration.md @@ -18,7 +18,8 @@ properties: description: "ResultName" ``` -- **backend info**: either path to a YAML-formatted file or pipestat config with PostgreSQL database login credentials. Note that the config file can also contain a path to the yaml-formatted results file: +- **backend info**: either path to a YAML-formatted file or pipestat config with PostgreSQL database login credentials. +- Note that the config file can also contain a path to the yaml-formatted results file: ```yaml schema_path: sample_output_schema.yaml #The config can contain either a results_file_path (file backend) or a database connection (database backend) @@ -35,6 +36,13 @@ database: ``` +Beginning with v0.10.0, there is also support for reporting results directly to PEPHub. Simply give PipestatManager a path to a PEPHub registry path: + +```python +psm = PipestatManager(pephub_path="databio/pipestat_demo:default", schema_path=my_schema_file_path) +``` + + Apart from that, there are many other *optional* configuration points that have defaults. Please refer to the [environment variables reference](http://pipestat.databio.org/en/dev/env_vars/) to learn about the the optional configuration options and their meaning. ## Configuration sources diff --git a/docs/pipestat/testing.md b/docs/pipestat/testing.md index 7eea6298..1cb9a957 100644 --- a/docs/pipestat/testing.md +++ b/docs/pipestat/testing.md @@ -18,9 +18,9 @@ Many of the tests require a postgres database to be set up otherwise many of the We recommend using docker: ```bash docker run --rm -it --name pipestat_test_db \ - -e POSTGRES_USER=postgres \ - -e POSTGRES_PASSWORD=pipestat-password \ + -e POSTGRES_USER=pipestatuser \ + -e POSTGRES_PASSWORD=shgfty^8922138$^! \ -e POSTGRES_DB=pipestat-test \ - -p 5432:5432 \ + -p 127.0.0.1:5432:5432 \ postgres ``` \ No newline at end of file