summaryrefslogtreecommitdiff
path: root/docs/getting-started.md
diff options
context:
space:
mode:
authorRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 02:39:01 +0000
committerRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 02:39:01 +0000
commitbf4e309a698592cdb815580f97db97b268fd6668 (patch)
treee8adb51a364d3fa617133f85603ab03d536ce849 /docs/getting-started.md
parentea8c349f6dce955696850198b8544d0203b467fb (diff)
downloadpyvyos-bf4e309a698592cdb815580f97db97b268fd6668.tar.gz
pyvyos-bf4e309a698592cdb815580f97db97b268fd6668.zip
docs: prepare v0.4.0 release
Rewrite the README around the supported public API, add a public API stability policy, document the deprecation timeline, and refresh the CHANGELOG with the full 0.4.0 scope. Add a short CONTRIBUTING guide. Apply minor pending fixes to LICENSE and .env.example. Fix a couple of verify=False antipatterns in the docs/ pages. README: - Badges (PyPI version, Python versions, license, CI). - Quick start that actually runs (no missing import, no global disable_warnings, correct VYDEVICE_VERIFY_SSL parse). - Environment variable table with defaults. - ApiResponse contract documented as a dataclass. - Compact API overview (configure / retrieve / show / generate / reset / config-file / system / image). - Public API stability section with the 0.4 -> 0.5 -> 0.6 -> 1.0 deprecation timeline. - Logging section: NullHandler default, pyvyos logger, redacted key. - VyOS compatibility note (1.4 LTS, 1.5 rolling). - Development with uv; optional pre-commit. CHANGELOG: - Consolidated 0.4.0 entry covering both the architecture refactor and this cleanup, since 0.4.0 was tagged in git but never published. - Explicit Added / Changed / Removed / Fixed / Compatibility / Notes sections. - 0.3.0 entry annotated as 'tagged but never released to PyPI'. CONTRIBUTING.md: - Scope statement (thin HTTPS API wrapper). - Pull request rules; explicit 'do not change HTTP payload in passing'. - Development setup with uv. - Public API stability summary. Fixes from the previous review-fixes branch: - LICENSE copyright now reads 'GravScale, Roberto Berto'. - .env.example default flipped to VYDEVICE_VERIFY_SSL=true with field descriptions. - docs/getting-started.md: VERIFY_SSL default to true; urllib3 disable_warnings now passes the specific InsecureRequestWarning. - docs/index.md: quick example uses verify=True; removed RTD link (RTD config was removed in this release because the build never worked).
Diffstat (limited to 'docs/getting-started.md')
-rw-r--r--docs/getting-started.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 183c109..3cf4891 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -21,7 +21,7 @@ VYDEVICE_HOSTNAME=192.168.1.1
VYDEVICE_APIKEY=your-api-key-here
VYDEVICE_PORT=443
VYDEVICE_PROTOCOL=https
-VYDEVICE_VERIFY_SSL=False
+VYDEVICE_VERIFY_SSL=true
```
## Step 3: Create Your First Script
@@ -54,7 +54,7 @@ If using `verify=False`, disable urllib3 warnings:
```python
import urllib3
-urllib3.disable_warnings()
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
```
## Understanding API Responses