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/installation.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/installation.md

(limited to 'docs/installation.md')

diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 0000000..e83974e
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,65 @@
+# Installation
+
+## Prerequisites
+
+PyVyOS requires Python 3.13 or higher. Make sure you have a compatible Python version installed.
+
+## Using pip
+
+The recommended way to install PyVyOS is using pip:
+
+```bash
+pip install pyvyos
+```
+
+## Using uv
+
+If you use `uv` for package management:
+
+```bash
+uv add pyvyos
+```
+
+## From Source
+
+To install from source:
+
+```bash
+git clone https://github.com/vyos-contrib/pyvyos.git
+cd pyvyos
+pip install .
+```
+
+## Verify Installation
+
+After installation, verify it works:
+
+```python
+from pyvyos import VyDevice
+print("PyVyOS installed successfully")
+```
+
+## Dependencies
+
+PyVyOS automatically installs:
+- `requests>=2.32.0` - HTTP library for API calls
+- `python-dotenv>=1.0.1` - Environment variable management
+- `urllib3>=2.5.0` - HTTP client utilities
+
+## Development Installation
+
+For development with testing support:
+
+```bash
+pip install pyvyos[dev]
+```
+
+This includes:
+- `pytest>=6.2.5` - Testing framework
+- `pytest-cov>=4.1` - Coverage reporting
+- `pytest-env>=0.6.2` - Environment variable testing
+
+## Next Steps
+
+After installation, proceed to [Getting Started](getting-started.md) to configure your first device connection.
+
-- 
cgit v1.2.3