feat: extract examples in separate files

Author: easySSP-dev

README.md

@@ -21,7 +21,10 @@ you're testing the API or building production workflows, these scripts will help
 
 ```bash
 easyssp-import-export-examples-python/
-├── demo.py                    # Run a basic scenario
+├── demo_config.py             # User agent and easySSP username and password config.
+├── ssd_import_demo.py         # Run a .ssd file import demo.
+├── ssp_export_demo.py         # Run a .ssp file export demo.
+├── ssp_import_demo.py         # Run a .ssp file import demo.
 ├── input/
 │   └── ssd_example.ssd        # SSD file for importing
 │   └── ssp_example.ssp        # SSP file for importing
@@ -67,8 +70,7 @@ uv sync
 
 ## 3. Provide your login credentials
 
-In the `demo.py` file, replace `your_easyssp_username` and `your_easyssp_password` with your real easySSP credentials
-to start the demo.
+In the `demo_config.py` file, provide your easySSP credentials to start the demo.
 
 ---
 
@@ -92,18 +94,20 @@ This separation of input and output ensures clarity, reproducibility, and easy c
 
 ---
 
-#### 🧪 `demo.py`
+#### 🧪 Demo
 
-The `demo.py` script in the `demo` directory acts as a **central demo runner** and contains example requests that show
+The `ssd_import_demo.py`, `ssp_export_demo.py`, and `ssp_import_demo.py` scripts in the `demo` directory act as **central demo runners** and contain example requests that show
 how to use the client.
-It's a great starting point if you're exploring the API for the first time or want to see full workflows in action.
-To start the demo, run
+They're a great starting point if you're exploring the API for the first time or want to see full workflows in action.
+To start a demo, run
 
 ```bash
 cd demo
-python -m demo
+python -m demo_file
 ```
 
+Replace `demo_file` with one of the following: `ssd_import_demo`, `ssp_export_demo` or `ssp_import_demo`.
+
 ## 📚 Related Projects
 
 ### 🧠 [**Import/Export Client**](https://github.com/exxcellent/easyssp-import-export-client-python)

demo/demo.py

@@ -0,0 +1,3 @@
+USER_AGENT = "easyssp-import-export-examples-python"
+EASYSSP_USERNAME = ""
+EASYSSP_PASSWORD = ""

demo/demo_config.py

@@ -0,0 +1,18 @@
+from easyssp_auth import AuthError
+from easyssp_import_export.client.import_export_client import ImportExportClient
+from easyssp_utils.client import ApiException
+from pydantic import ValidationError
+from demo_config import USER_AGENT, EASYSSP_USERNAME, EASYSSP_PASSWORD
+
+with (open("../input/ssd_example.ssd", "rb") as ssd_input_file):
+    try:
+        import_export_client = ImportExportClient(username=EASYSSP_USERNAME, password=EASYSSP_PASSWORD,
+                                                  user_agent=USER_AGENT)
+        # import a .ssd file
+        ssd_import_result = import_export_client.import_ssd(filename="ssd_import_example.ssd",
+                                                            body=ssd_input_file.read())
+        print(ssd_import_result.data)
+    # catch ValidationError for incorrect request parameters
+    # catch ApiException for errors from the API client or the server
+    except (AuthError, ApiException, ValidationError) as ex:
+        print(ex)

demo/ssd_import_demo.py

@@ -0,0 +1,21 @@
+from easyssp_auth import AuthError
+from easyssp_import_export.client.import_export_client import ImportExportClient
+from easyssp_utils.client import ApiException
+from pydantic import ValidationError
+from demo_config import USER_AGENT, EASYSSP_USERNAME, EASYSSP_PASSWORD
+
+with (open("../output/ssp_output.ssp", "wb") as ssp_output_file):
+    try:
+        import_export_client = ImportExportClient(username=EASYSSP_USERNAME, password=EASYSSP_PASSWORD,
+                                                  user_agent=USER_AGENT)
+        # get the SSP model id from the console
+        ssp_id = input("Enter SSP model id: ")
+
+        # export it to .ssp file
+        ssp_export_result = import_export_client.export_ssp(ssp_id=ssp_id)
+        ssp_output_file.write(ssp_export_result.data)  # write the exported file to the file system
+        print("The SSP model has been successfully exported.")
+    # catch ValidationError for incorrect request parameters
+    # catch ApiException for errors from the API client or the server
+    except (AuthError, ApiException, ValidationError) as ex:
+        print(ex)

demo/ssp_export_demo.py

@@ -0,0 +1,19 @@
+from easyssp_auth import AuthError
+from easyssp_import_export.client.import_export_client import ImportExportClient
+from easyssp_utils.client import ApiException
+from pydantic import ValidationError
+from demo_config import USER_AGENT, EASYSSP_USERNAME, EASYSSP_PASSWORD
+
+with (open("../input/ssp_example.ssp", "rb") as ssp_input_file):
+    try:
+        import_export_client = ImportExportClient(username=EASYSSP_USERNAME, password=EASYSSP_PASSWORD,
+                                                  user_agent=USER_AGENT)
+
+        # import a .ssp file
+        ssp_import_result = import_export_client.import_ssp(filename="ssp_import_example.ssp",
+                                                            body=ssp_input_file.read())
+        print(ssp_import_result.data)
+    # catch ValidationError for incorrect request parameters
+    # catch ApiException for errors from the API client or the server
+    except (AuthError, ApiException, ValidationError) as ex:
+        print(ex)