blob: e83974e01050cd20e63d68b13d3c7a95b060bbdf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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.
|
