JSON support documentation

.vscode/launch.json

@@ -138,6 +138,17 @@
                 "examples/minute_parity"
             ]
         },
+        {
+            "name": "Python: Example JSON storage",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "hardpy.cli.cli",
+            "console": "integratedTerminal",
+            "args": [
+                "run",
+                "examples/json_storage"
+            ]
+        },
         {
             "name": "Python: Example Multiple configs",
             "type": "debugpy",

README.md

@@ -13,7 +13,7 @@ HardPy is a python library for creating a test bench for devices.
 [![pytest versions](https://img.shields.io/badge/pytest-%3E%3D7.0-blue)](https://docs.pytest.org/en/latest/)
 [![Documentation](https://img.shields.io/badge/Documentation%20-Overview%20-%20%23007ec6)](https://everypinio.github.io/hardpy/)
 [![Reddit](https://img.shields.io/badge/-Reddit-FF4500?style=flat&logo=reddit&logoColor=white)](https://www.reddit.com/r/HardPy)
-[![Discord](https://img.shields.io/discord/1304494076799877172?color=7389D8&label&logo=discord&logoColor=ffffff)]()
+[![Discord](https://img.shields.io/discord/1304494076799877172?color=7389D8&label&logo=discord&logoColor=ffffff)](https://discord.gg/98bWadmG8J)
 [![Telegram](https://img.shields.io/badge/-Telegram-2CA5E0?style=flat&logo=telegram&logoColor=white)](https://t.me/everypin)
 
 </div>
@@ -26,7 +26,7 @@ HardPy allows you to:
 
 * Create test benches for devices using [pytest](https://docs.pytest.org/);
 * Use a browser to view, start, stop, and interact with tests;
-* Store test results in the [CouchDB](https://couchdb.apache.org/) database;
+* Store test results in the [CouchDB](https://couchdb.apache.org/) database or to simple JSON files;
 * Store test results on the [StandCloud](https://standcloud.io/) analytics platform.
 
 <h1 align="center">
@@ -41,6 +41,8 @@ pip install hardpy
 
 ## Getting Started
 
+### With CouchDB
+
 1. Create your first test bench.
 ```bash
 hardpy init
@@ -59,6 +61,18 @@ hardpy run
 
     Login and password: **dev**, database - **runstore**.
 
+### Without a database
+
+1. Create your first test bench.
+```bash
+hardpy init --no-create-database --storage-type json
+```
+2. Launch HardPy operator panel.
+```bash
+hardpy run
+```
+3. View operator panel in browser: http://localhost:8000/
+
 ## Examples
 
 For more examples of using **HardPy**, see the [examples](https://github.com/everypinio/hardpy/tree/main/examples) folder and the [documentation](https://everypinio.github.io/hardpy/examples/).

docs/changelog.md

@@ -2,6 +2,11 @@
 
 Versions follow [Semantic Versioning](https://semver.org/): `<major>.<minor>.<patch>`.
 
+## 0.20.0
+
+* Add JSON file storage support as alternative to CouchDB.
+  [[PR-239](https://github.com/everypinio/hardpy/pull/239)]
+
 ## 0.19.1
 
 * Add a `stop_time` validator function. If a case or module has a start time,
@@ -19,7 +24,7 @@ Versions follow [Semantic Versioning](https://semver.org/): `<major>.<minor>.<pa
   tests to run via UI checkboxes.
   [[PR-224](https://github.com/everypinio/hardpy/pull/224)]
 * Add multiple test plan configurations.
-  [[PR-225]](https://github.com/everypinio/hardpy/pull/225)
+  [[PR-225](https://github.com/everypinio/hardpy/pull/225)]
 
 ## 0.18.3
 

docs/documentation/cli.md

@@ -53,6 +53,7 @@ More info in [hardpy config](./hardpy_config.md).
 |                                                         [default: no-sc-autosync]                          │
 |                                                         [default: check-stand-cloud]                       │
 │ --sc-api-key                                  TEXT      Specify a StandCloud API key.                      │
+│ --storage-type                                TEXT      Specify a storage type. [default: couchdb]         |
 │ --help                                                  Show this message and exit.                        │
 ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```

docs/documentation/hardpy_config.md

@@ -30,7 +30,7 @@ tests_name = "My tests"
 current_test_config = ""
 
 [database]
-storage_type = "json"
+storage_type = "couchdb"
 user = "dev"
 password = "dev"
 host = "localhost"
@@ -88,13 +88,21 @@ Storage type. The default is `couchdb`.
 
 - `couchdb`: Stores test results and measurements in a CouchDB database. Requires a running CouchDB instance.
 - `json`: Stores test results and measurements in local JSON files. No external database required. 
+
 Files are stored in the `.hardpy` directory in the root of the project.
 The user can change this value with the `hardpy init --storage-type` option.
 
 #### storage_path
 
 Path to the storage directory. The default is `.hardpy` in the root of the project.
-The user can change this value with the `hardpy init --storage-path` option. Relative and absolute paths are supported.
+The user can change this value in the hardpy.toml file using the `storage_path` option. 
+Both relative and absolute paths are supported.
+
+```toml
+[database]
+storage_type = "json"
+storage_path = "result"
+```
 
 #### user
 

docs/documentation/pytest_hardpy.md

@@ -911,6 +911,35 @@ def fill_actions_after_test(post_run_functions: list):
     yield
 ```
 
+#### JsonLoader
+
+Used to write reports to the JSON.
+
+**Arguments:**
+
+- `storage_dir` *(Path | None)*: JSON file directory.
+
+**Functions:**
+
+- `load` *(ResultRunStore, new_report_id)*: Load report to the JSON file.
+
+**Example:**
+
+```python
+# conftest
+def save_report_to_dir():
+    report = get_current_report()
+    if report:
+        loader = JsonLoader(Path.cwd() / "reports")
+        loader.load(report)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def fill_actions_after_test(post_run_functions: list):
+    post_run_functions.append(save_report_to_dir)
+    yield
+```
+
 #### StandCloudLoader
 
 Used to write reports to the **StandCloud**.