From 6b4e9015744ab8c9f17a6b8e23387cd676b1d827 Mon Sep 17 00:00:00 2001
From: roberto berto <rberto@deepcausa.com>
Date: Sun, 2 Nov 2025 22:54:44 +0000
Subject: feat: v0.4.0 - Architecture refactor, bug fixes, and quality
 improvements

- Fixed #25: config_file_save/load now include path: [] in payload
- Added exception hierarchy (SDKError, HttpError, ApiError, ValidationError)
- Added utility functions (json, ids, paths)
- Added structured logging with request ID tracking
- Added optional Pydantic validation models
- Refactored to pyvyos.core.* structure with backward compatibility shims
- Moved JSON specs to docs/development/vyos_api/
- Added comprehensive test suite (19 shim tests, 16 utils tests, 6 exception tests)
- Updated pyproject.toml for uv sync editable installation
- Added development documentation (architecture, roadmap, quality guidelines)

Maintains 100% backward compatibility with 0.3.0
---
 docs/getting-started.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 docs/getting-started.md

(limited to 'docs/getting-started.md')

diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 0000000..183c109
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,77 @@
+# Getting Started
+
+This guide will help you set up PyVyOS and make your first API call to a VyOS device.
+
+## Prerequisites
+
+- VyOS device with REST API enabled
+- API key generated on your VyOS device
+- Network access to your VyOS device
+
+## Step 1: Install PyVyOS
+
+See [Installation](installation.md) for detailed instructions.
+
+## Step 2: Configure Environment Variables
+
+Create a `.env` file in your project directory:
+
+```bash
+VYDEVICE_HOSTNAME=192.168.1.1
+VYDEVICE_APIKEY=your-api-key-here
+VYDEVICE_PORT=443
+VYDEVICE_PROTOCOL=https
+VYDEVICE_VERIFY_SSL=False
+```
+
+## Step 3: Create Your First Script
+
+```python
+import os
+from dotenv import load_dotenv
+from pyvyos import VyDevice
+
+load_dotenv()
+
+device = VyDevice(
+    hostname=os.getenv('VYDEVICE_HOSTNAME'),
+    apikey=os.getenv('VYDEVICE_APIKEY'),
+    port=os.getenv('VYDEVICE_PORT'),
+    protocol=os.getenv('VYDEVICE_PROTOCOL'),
+    verify=os.getenv('VYDEVICE_VERIFY_SSL', 'True').lower() == 'true'
+)
+
+response = device.show(path=["system", "image"])
+if not response.error:
+    print(response.result)
+else:
+    print(f"Error: {response.error}")
+```
+
+## Step 4: Disable SSL Warnings (Optional)
+
+If using `verify=False`, disable urllib3 warnings:
+
+```python
+import urllib3
+urllib3.disable_warnings()
+```
+
+## Understanding API Responses
+
+All methods return an `ApiResponse` object with:
+- `status`: HTTP status code
+- `request`: Request payload (API key sanitized)
+- `result`: Response data dictionary
+- `error`: Error message (False if successful)
+
+## Common Operations
+
+See [Examples](examples.md) for more detailed usage patterns.
+
+## Next Steps
+
+- Read [API Reference](api-reference.md) for complete method documentation
+- Explore [Configuration](configuration.md) for advanced setup
+- Check [Concepts](concepts.md) to understand PyVyOS architecture
+
-- 
cgit v1.2.3