Bump version to 0.2.0, clarify docs

Author: PaulWinterstein

README.md

@@ -29,7 +29,7 @@ The provided methods and data models ensure easy handling, robust validation, co
 ### Prerequisites
 
 - Access to a VideoIPath Server (version 2023.4.2 or higher, LTS versions recommended)
-- A user account with API access credentials
+- Username and Password for a user account with API access
 - Python 3.11 or higher
 
 ### Installation
@@ -39,7 +39,7 @@ The package is available via the [Python Package Index (PyPI)](https://pypi.org/
 #### Install the package using pip
 
 ```bash
-pip3 install videoipath-automation-tool
+pip install videoipath-automation-tool
 ```
 
 ### A Simple Example: Adding a Device to the Inventory
@@ -49,7 +49,7 @@ pip3 install videoipath-automation-tool
 from videoipath_automation_tool import VideoIPathApp
 
 # Initialize the VideoIPathApp
-app = VideoIPathApp(server_address="10.1.100.10", username="api-user", password="veryStrongPassword")
+app = VideoIPathApp(server_address="10.1.100.10", username="api-user", password="veryStrongPassword", use_https=False, verify_ssl_cert=False)
 
 # Create a device object with NMOS Multidevice driver
 staged_device = app.inventory.create_device(driver="com.nevion.NMOS_multidevice-0.1.0")

docs/development-and-release.md

@@ -22,7 +22,7 @@ For stable/official versions, the common semver pattern is used:
 For development versions, there are multiple options - since this package doesn't have a complex testing and verification process for release,
 a simple format is used:
 
-`<Major>.<Minor>.<Patch>.dev+<short commit SHA>`
+`<Major>.<Minor>.<Patch>.dev<GitHub Action Run ID>`
 
 Pip won't treat those versions as stable, they can only be installed by specifying the exact version or using the `--pre` flag.
 
@@ -71,7 +71,7 @@ flowchart TD
     subgraph run-mr-pipeline["Run Merge-Request Pipeline"]
         mr-tests["Run Tests [Pipeline]"]
         mr-build["Build the Package [Pipeline]"]
-        publish-dev-version["Publish Dev Version, e.g. 1.3.6.dev+d882293d [Pipeline]"]
+        publish-dev-version["Publish Dev Version, e.g. 1.3.6.dev256 [Pipeline]"]
 
         mr-tests --> mr-build
         mr-build --> publish-dev-version

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "videoipath-automation-tool"
-version = "0.1.6"
+version = "0.2.0"
 description = "A Python package for automating VideoIPath configuration workflows."
 authors = ["Paul Winterstein <paul.winterstein@swr.de>"]
 maintainers = ["SWR Media-over-IP Team <moip@swr.de>", "Josia Hildebrandt <manuel_josia.hildebrandt@swr.de>"]