diff options
Diffstat (limited to 'docs/installation.md')
| -rw-r--r-- | docs/installation.md | 65 |
1 files changed, 65 insertions, 0 deletions
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. + |
