Miscellaneous Reference
kevinbotlib.util
kevinbotlib.util.fullclassname(o)
Get the full name of a class
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
o
|
object
|
The class to retrieve the full name of |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
The name of the module and class |
kevinbotlib.util.is_binary()
Detect if the application is running as a frozen executable or not.
Returns:
| Type | Description |
|---|---|
bool
|
Is frozen? |
kevinbotlib.util.socket_exists(host='localhost', port=6379, timeout=1.0)
Check if a TCP socket exists Args: host: Host to check port: Port to check timeout: Socket connection timeout
Returns:
| Type | Description |
|---|---|
bool
|
Socket exists? |
kevinbotlib.licenses
kevinbotlib.licenses.get_licenses()
Return all licenses of KevinbotLib and it's dependencies
Returns:
| Type | Description |
|---|---|
dict[str, str]
|
dict[str, str]: license name-license text |
kevinbotlib.deployment
kevinbotlib.deployment.GitManifestData
Bases: TypedDict
Git data generated by the deployment process.
branch
instance-attribute
Git branch
tag
instance-attribute
Git tag
commit
instance-attribute
Git commit
kevinbotlib.deployment.Manifest
dataclass
Manifest contents generated by the deployment process.
deploytool
instance-attribute
KevinbotLib DeployTool Version
timestamp
instance-attribute
Deployment UTC Timestamp
git
instance-attribute
Deployment Git Data
robot
instance-attribute
Deployed Robot Name
kevinbotlib.deployment.ManifestParser
Parser for the deployment manifest.
path
property
Get the manifest path.
Returns:
| Type | Description |
|---|---|
Path
|
pathlib.Path: Manifest path. |
manifest
property
__init__(path=None)
Parse the deployment manifest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
Path | str | None
|
The deployment manifest path. Defaults to "deploy/manifest.json" in the current working directory. |
None
|