Skip to content

HardPy config

HardPy uses the hardpy.toml file for configuration. The user can change the fields at creation by using hardpy init.

Note

All HardPy project must have hardpy.toml file.

Minimal configuration file

title = "HardPy TOML config"

[database]
user = "dev"
password = "dev"
host = "localhost"
port = 5984

[frontend]
host = "localhost"
port = 8000

Full configuration file

title = "HardPy TOML config"
tests_name = "My tests"

[database]
user = "dev"
password = "dev"
host = "localhost"
port = 5984

[frontend]
host = "localhost"
port = 8000
language = "en"
full_size_button = false
sound_on = false

[frontend.modal_result]
enable = false
auto_dismiss_pass = true
auto_dismiss_timeout = 5

[stand_cloud]
address = "demo.standcloud.io"
connection_only = true

Configuration fields description

common

Common settings.

title

Configuration file header. The value is always HardPy TOML config.

tests_name

Tests name. The user can change this value with the hardpy init --tests-name argument.

database

Database settings.

user

Database user name. The default is dev. The user can change this value with the hardpy init --database-user option.

password

Database password. The default is dev. The user can change this value with the hardpy init --database-password option.

host

Database host name. The default is localhost. The user can change this value with the hardpy init --database-host option.

port

Database port number. The default is 5984. The user can change this value with the hardpy init --database-port option.

frontend

Frontend (operator panel) settings.

host

Operator panel host name. The default is localhost. The user can change this value with the hardpy init --frontend-host option.

port

Operator panel port number. The default is 8000. The user can change this value with the hardpy init --frontend-port option.

language

Language of operator panel. The default is en. Available languages are there.

full_size_button

Enable full-size start/stop button layout in operator panel. When set to true, the button will be displayed in full-size layout with larger dimensions and centered positioning. Default is false.

sound_on

Enable or disable test completion sound notifications. When set to true, sound will play when test execution completes (PASS/FAIL/STOP status). Default is false.

Modal result windows settings for test completion display.

[frontend.modal_result]
enable = false
auto_dismiss_pass = true
auto_dismiss_timeout = 5
enable

Enable or disable test completion modal result windows. When set to true, modal windows will display test completion status (PASS/FAIL/STOP) at the end of test execution. Default is false.

auto_dismiss_pass

Automatically dismiss PASS result modals after the timeout period. When set to true, PASS results will automatically close without requiring user interaction. FAIL and STOP results always require manual dismissal. Default is true.

auto_dismiss_timeout

Timeout in seconds for auto-dismissing PASS result modals. Applies only when auto_dismiss_pass = true. Default is 5 seconds.

stand_cloud

StandCloud settings.

[stand_cloud]
address = "demo.standcloud.localhost"
connection_only = true

address

StandCloud service address. To obtain one, contact info@everypin.io.

connection_only

Boolean variable, if set to true, HardPy will check the connection to the StandCloud service at each startup before running tests. The default value is false.

If the connection fails, the tests will not run.