fastiot.cli.commands package

commands

This package holds all cli commands defined in the fastiot cli tool

Submodules

fastiot.cli.commands.build module

Build command

fastiot.cli.commands.build.build(services=<typer.models.ArgumentInfo object>, mode=<typer.models.OptionInfo object>, tag=<typer.models.OptionInfo object>, docker_registry=<typer.models.OptionInfo object>, docker_registry_cache=<typer.models.OptionInfo object>, platform=<typer.models.OptionInfo object>, dry=<typer.models.OptionInfo object>, push=<typer.models.OptionInfo object>, test_deployment_only=<typer.models.OptionInfo object>, no_cache=<typer.models.OptionInfo object>)

This command builds images.

Per default, it builds all images. Optionally, you can specify a single image to build.

fastiot.cli.commands.build_lib module

Commands to compile the project library

class fastiot.cli.commands.build_lib.BuildLibStyles(value)

An enumeration.

all = 'all'

force_all = 'force-all'

compiled = 'compiled'

wheel = 'wheel'

sdist = 'sdist'

fastiot.cli.commands.build_lib.build_lib(build_style=<typer.models.ArgumentInfo object>, noupdate=<typer.models.OptionInfo object>)

Compile the project library according to the project configuration.

fastiot.cli.commands.build_lib.update_pyproject_toml(build_system=None, update_requirements=False)

Parameters:

• build_system (Optional[Dict]) – Add a dictionary to be inserted into the buildsytem-part of the pyproject.toml

• update_requirements (Optional[bool]) – Use with care! This is basically for the old style, where requirements were managed in requirements/requirements.txt and not in pyproject.toml. This should be needed only once, when migrating.

Returns:

Return type:

fastiot.cli.commands.build_lib.read_oldstyle_requirements()

fastiot.cli.commands.clean module

fastiot.cli.commands.clean.clean(do_clean_all=<typer.models.OptionInfo object>)

This command cleans up all generated files and removes all container and images from docker daemon.

fastiot.cli.commands.clean.remove_all_container(kill=<typer.models.OptionInfo object>)

Remove all running container

fastiot.cli.commands.config module

fastiot.cli.commands.config.config(deployments=<typer.models.ArgumentInfo object>, tag=<typer.models.OptionInfo object>, docker_registry=<typer.models.OptionInfo object>, net=<typer.models.OptionInfo object>, pull_always=<typer.models.OptionInfo object>, use_test_deployment=<typer.models.OptionInfo object>, port_offset=<typer.models.OptionInfo object>, use_port_import=<typer.models.OptionInfo object>)

This command generates deployment configs. Per default, it generates all configs. Optionally, you can specify a config to only generate a single deployment config. All generated files will be placed inside the build dir of your project.

For each service the docker images will be executed to import the manifest.yaml file. Therefore, if you want to build one or more deployments you have to be logged in and connected to the corresponding docker registries or build the images locally.

fastiot.cli.commands.create module

Commands for generating new projects and services.

fastiot.cli.commands.create.new_project(project_name=<typer.models.ArgumentInfo object>, force=<typer.models.OptionInfo object>, target_directory=<typer.models.OptionInfo object>, description=<typer.models.OptionInfo object>)

Function to create a new project with its directory structure and all needed files for a quick start.

You may use the function new-service afterwards to create your first service stubs.

fastiot.cli.commands.create.new_service(service_name=<typer.models.ArgumentInfo object>, service_package=<typer.models.OptionInfo object>, force=<typer.models.OptionInfo object>)

Create a new service with some method stubs for further programming.

fastiot.cli.commands.create.pyproject_toml(description=<typer.models.OptionInfo object>, force=<typer.models.OptionInfo object>)

Creates a new pyproject.toml to build the library.

fastiot.cli.commands.create.create_toml(path, project_name, short_description='')

fastiot.cli.commands.deploy module

Command for automatic deployments using ansible playbooks

fastiot.cli.commands.deploy.deploy(deployments=<typer.models.ArgumentInfo object>, ask_pass=<typer.models.OptionInfo object>, dry=<typer.models.OptionInfo object>)

This command handles deployment of a config using an Ansible Playbook if you have configured any deployments based on fastiot.cli.model.deployment.DeploymentTargetSetup in your deployment.yaml.

fastiot.cli.commands.manage_requirements module

fastiot.cli.commands.manage_requirements.set_requirements(update_requirements=<typer.models.OptionInfo object>)

Updates requirements.txt and files in path requirements according to the settings in your pyproject.toml.

fastiot.cli.commands.nuitka_compile module

Command to compile services and packages with Nuitka

fastiot.cli.commands.nuitka_compile.nuitka_compile(package_name=<typer.models.ArgumentInfo object>, src_dir=<typer.models.OptionInfo object>, out_dir=<typer.models.OptionInfo object>, install_nuitka=<typer.models.OptionInfo object>)

Compiles the selected path as .so file using nuitka. Please make sure to have Nuitka installed as this is an optional dependency.

fastiot.cli.commands.print module

class fastiot.cli.commands.print.ToPrint(value)

An enumeration.

project_namespace = 'project_namespace'

library_package = 'library_package'

library_setup_py_dir = 'library_setup_py_dir'

services = 'services'

deployments = 'deployments'

integration_test_deployment = 'integration_test_deployment'

test_package = 'test_package'

npm_test_dir = 'npm_test_dir'

fastiot.cli.commands.print.check_name(name)

fastiot.cli.commands.print.print_cmd(name=<typer.models.ArgumentInfo object>, deployment=<typer.models.OptionInfo object>, platform=<typer.models.OptionInfo object>)

Prints project related variables

fastiot.cli.commands.run_tests module

class fastiot.cli.commands.run_tests.TestRunner(value)

Specify the test runner

unittest = 'unittest'

Use python’s builtin unittest

pytest = 'pytest'

Use pytest. This lib must be installed

pytest_cov = 'pytest-cov'

Use pytest with test coverage option. Please note, that pytest-cov must be installed

fastiot.cli.commands.run_tests.run_tests(start_deployment=<typer.models.OptionInfo object>, test_runner=<typer.models.OptionInfo object>)

This command will trigger all unittests found in the configured test package. You may use the option –start-deployment to also run your integration test deployment with message broker, ….

fastiot.cli.commands.start module

fastiot.cli.commands.start.start(deployment_name=<typer.models.ArgumentInfo object>, service_names=<typer.models.ArgumentInfo object>, detach=<typer.models.OptionInfo object>, project_name=<typer.models.OptionInfo object>, use_test_deployment=<typer.models.OptionInfo object>, pull_always=<typer.models.OptionInfo object>)

Starts the selected environment. Be aware that the configuration needs to be built manually before using fiot config.

fastiot.cli.commands.stop module

Implements some stop commands for e.g. environments.

fastiot.cli.commands.stop.stop(deployment_name=<typer.models.ArgumentInfo object>, service_names=<typer.models.ArgumentInfo object>, project_name=<typer.models.OptionInfo object>, use_test_deployment=<typer.models.OptionInfo object>)

Stops the selected environment.

fastiot.cli.commands.version module

fastiot.cli.commands.version.version(complete=<typer.models.OptionInfo object>, only_major=<typer.models.OptionInfo object>, minor=<typer.models.OptionInfo object>)

Shows current version depending on git commits and tags