Release prep for v0.5 (#188)

* Update releases.md

* Cleaner documentation

* Update pyproject.toml

Author: fretchen

docs/dropbox.md

@@ -0,0 +1,10 @@
+---
+comments: true
+---
+
+# API documentation of the Dropbox provider
+
+::: src.sqooler.storage_providers.dropbox
+    handler: python 
+    options:
+      show_source: true

docs/local.md

@@ -0,0 +1,10 @@
+---
+comments: true
+---
+
+# API documentation of the local storage provider
+
+::: src.sqooler.storage_providers.local
+    handler: python 
+    options:
+      show_source: true

docs/mongodb.md

@@ -0,0 +1,10 @@
+---
+comments: true
+---
+
+# API documentation of the mongodb provider
+
+::: src.sqooler.storage_providers.mongodb
+    handler: python 
+    options:
+      show_source: true

docs/releases.md

@@ -7,6 +7,21 @@ comments: true
 
 In this guide we will cover the key information about the different releases.
 
+## v0.5
+
+This release further increased the typing and testing of the package. It also fixed some long standing usability bugs for the user. 
+
+What Changed:
+
+* Cleaner error handling of missing status
+* Unify the error handling for the `get_file_content` function amongst `StorageProvider`s.
+* Put the different `StorageProvider`s into the `storage_provider` module to make it easier to add new ones.
+* Type and verify the status string to be "INITIALIZING", "QUEUED", "DONE", "ERROR" and introduce the functions `get_init_status` as well as `get_init_results` that help with the initialization.
+* Clean out the names given to the backends and storage providers such that they conform with the intended logic of being alphanumeric names only.
+* Enforce the coupling map of the `GateInstruction`.
+* Give back the measured wires and the instructions for each *experiment* to make it easier to reconstruct. 
+* Introduced the new `DataDict` for better typing for the results.
+
 ## v0.4
 
 This release focused on better typing with `pydantic` and a simpler deployment on the back-end side.

docs/storage_providers.md

@@ -4,7 +4,13 @@ comments: true
 
 # API documentation of storage providers
 
-::: src.sqooler.storage_providers
+
+::: src.sqooler.storage_providers.base
+    handler: python 
+    options:
+      show_source: false
+
+::: src.sqooler.storage_providers.mongodb
     handler: python 
     options:
       show_source: true

mkdocs.yml

@@ -18,8 +18,12 @@ nav:
   - "Modules":
     - "Schemes": "schemes.md"
     - "Utils": "utils.md"
-    - "Storage providers": "storage_providers.md"
     - "Spoolers": "spoolers.md"
+  - "Storage Providers":
+    - "Basics": "storage_providers.md"
+    - "MongoDB": "mongodb.md"
+    - "Local storage": "local.md"
+    - "Dropbox": "dropbox.md"
 
 repo_url: https://github.com/alqor-ug/sqooler
 edit_uri: edit/main/docs/

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sqooler"
-version = "0.5.0a0"
+version = "0.5.0"
 description = "Code that enables validated cloud access to quantum hardware (simulators)"
 authors = ["fretchen <fred.jendrzejewski@gmail.com>"]
 repository = "https://github.com/Alqor-UG/sqooler"