vws-web-tools¶
Installation¶
pip install vws-web-tools
This is tested on Python 3.12+.
Usage¶
vws-web-tools¶
Commands for interacting with VWS.
Usage
vws-web-tools [OPTIONS] COMMAND [ARGS]...
create-vws-cloud-database¶
Create a cloud database.
Usage
vws-web-tools create-vws-cloud-database [OPTIONS]
Options
- --license-name <license_name>¶
Required
- --database-name <database_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
create-vws-license¶
Create a license.
Usage
vws-web-tools create-vws-license [OPTIONS]
Options
- --license-name <license_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
create-vws-vumark-database¶
Create a VuMark database.
Usage
vws-web-tools create-vws-vumark-database [OPTIONS]
Options
- --database-name <database_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
delete-vws-license¶
Delete a license.
Usage
vws-web-tools delete-vws-license [OPTIONS]
Options
- --license-name <license_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
get-vumark-instance-id¶
Get the VuMark instance ID for a target.
Usage
vws-web-tools get-vumark-instance-id [OPTIONS]
Options
- --database-name <database_name>¶
Required
- --target-name <target_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
show-database-details¶
Show the details of a database.
Usage
vws-web-tools show-database-details [OPTIONS]
Options
- --database-name <database_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
- --env-var-format¶
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
show-license-details¶
Show the details of a license.
Usage
vws-web-tools show-license-details [OPTIONS]
Options
- --license-name <license_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
- --env-var-format¶
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
show-vumark-database-details¶
Show the details of a VuMark database.
Usage
vws-web-tools show-vumark-database-details [OPTIONS]
Options
- --database-name <database_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
- --env-var-format¶
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
upload-vumark-template¶
Upload a VuMark SVG template to a VuMark database.
Usage
vws-web-tools upload-vumark-template [OPTIONS]
Options
- --database-name <database_name>¶
Required
- --svg-file-path <svg_file_path>¶
Required
- --template-name <template_name>¶
Required
- --width <width>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
wait-for-vumark-instance-id¶
Wait for and get the VuMark instance ID for a target.
Usage
vws-web-tools wait-for-vumark-instance-id [OPTIONS]
Options
- --database-name <database_name>¶
Required
- --target-name <target_name>¶
Required
- --email-address <email_address>¶
Required
- --password <password>¶
Required
- --timeout <timeout>¶
- Default:
180
Environment variables
- VWS_EMAIL_ADDRESS
Provide a default for
--email-address
- VWS_PASSWORD
Provide a default for
--password
Reference¶
- Python API
DatabaseDictLicenseDictVuMarkDatabaseDict_dismiss_cookie_banner()_find_vumark_target_link()_log_in_once()_open_add_database_dialog()_submit_add_database_dialog()_xpath_literal()create_chrome_driver()create_cloud_database()create_license()create_vumark_database()delete_license()get_database_details()get_license_details()get_vumark_database_details()get_vumark_target_id()log_in()navigate_to_database()navigate_to_license()upload_vumark_template()wait_for_logged_in()wait_for_vumark_target_link()
- Contributing to vws-web-tools
- Release Process
- Changelog