index.md

API Overview

Modules

• velocitas_lib
• velocitas_lib.conan_utils
• velocitas_lib.docker
• velocitas_lib.file_utils
• velocitas_lib.functional_interface
• velocitas_lib.middleware
• velocitas_lib.services
• velocitas_lib.templates
• velocitas_lib.text_utils
• velocitas_lib.variables

Classes

• middleware.MiddlewareType: Enumeration containing all possible middleware types.
• services.Service: Service(id, config)
• services.ServiceSpecConfig: ServiceSpecConfig(image, is_enabled, env_vars, args, ports, port_forwards, mounts, startup_log_patterns)
• templates.CopySpec: Copy specification of a single file or directory.
• variables.ProjectVariables

Functions

• velocitas_lib.create_log_file: Create a log file for the given service and runtime.
• velocitas_lib.discover_files_in_filetree: Recursively search for files with a specific file type under the tree root.
• velocitas_lib.download_file
• velocitas_lib.extract_zip: Extract a zip file.
• velocitas_lib.get_app_manifest
• velocitas_lib.get_cache_data: Return the data of the cache as Python object.
• velocitas_lib.get_log_file_name: Build the log file name for the given service and runtime.
• velocitas_lib.get_package_path: Return the absolute path to the package directory the invoked Python
• velocitas_lib.get_programming_language: Return the programming language of the project.
• velocitas_lib.get_project_cache_dir: Return the project's cache directory.
• velocitas_lib.get_script_path: Return the absolute path to the directory the invoked Python script
• velocitas_lib.get_valid_arch: Return a known architecture for the given arch.
• velocitas_lib.get_workspace_dir: Return the workspace directory.
• velocitas_lib.have_internet_connection
• velocitas_lib.is_uri: Check if the provided path is a URI.
• velocitas_lib.obtain_local_file_path: Return the absolute path to the file, specified by a absolute/relative local path or with an URI.
• velocitas_lib.require_env: Require and return an environment variable.
• conan_utils.add_dependency_to_conanfile: Add the dependency name to the project's list of dependencies.
• conan_utils.export_conan_project: Export a conan project to the local conan cache.
• conan_utils.get_required_sdk_version: Return the required version of the core SDK.
• docker.build_vehicleapp_image: Build VehicleApp docker image and display the progress using a spinner.
• docker.container_exists: Check if a container with a given name exists.
• docker.is_docker_image_build_locally: Check if vehicle app docker image is locally available
• docker.push_docker_image_to_registry: Push docker image to local image registry
• file_utils.capture_area_in_file: Capture an area of a textfile between a matching start line (exclusive) and the first line matching end_line (exclusive).
• file_utils.read_file: Reads the file with the given file_path and returns it's content as a str.
• file_utils.replace_text_in_file: Replace all occurrences of text in a file with a replacement.
• file_utils.write_file: Writes the content to the file_path and returns the success of the write operation.
• functional_interface.get_interfaces_for_type: Return all interfaces for the given type.
• middleware.get_middleware_type: Return the current middleware type.
• services.get_service_port: Return the service port as string for the specified service.
• services.get_services: Return all specified services as Python object.
• services.get_specific_service: Return the specified service as Python object.
• services.parse_service_config: Parse service spec configuration and return it as an named tuple.
• services.resolve_functions
• templates.copy_templates: Copy templates from the template dir to the target dir.
• text_utils.create_truncated_string: Create a truncated version of input if it is longer than length.
• text_utils.replace_item_in_list: Replace the whole line which matches the given text with a replacement.
• text_utils.replace_text_area: Replace all occurrences of all text areas matching the parameters with a replacement.
• text_utils.to_camel_case: Return a camel case version of a snake case string.
• variables.json_obj_to_flat_map: Flatten a JSON Object into a one dimensional dict by joining the keys

---

This file was automatically generated via lazydocs.