API

class amoni.api.AmoniRemoteCallbacks(*args: Any, **kwargs: Any)
amoni.api.add_submodule(url: str, path: Path, name: str) None

Add a submodule to the current repository

Parameters:
  • url – The url of the submodule to add

  • path – The directory where the submodule should be added

  • name – The name of the submodule

amoni.api.build_image(name: str) None

Build a docker image :param name: The name of the image to pull

amoni.api.build_theme(app: str) None

Build the theme for the given app

Parameters:

app – The name of the app

amoni.api.generate_table_stubs(app: str, target: Path = PosixPath('anvil-stubs/tables/app_tables.pyi')) None

Generate stub entries for app tables in anvil.yaml

Parameters:
  • app – The name of the app

  • target – The stub file where the entries should be added

amoni.api.init(directory: Path, app: str) None

Initialise an amoni project

Parameters:
  • directory – The full path of the amoni project folder to create

  • app – The name of folder within the ‘app’ folder which contains the app to be run

amoni.api.pull_image(name: str) None

Pull a docker image from the github registry

Parameters:

name – The name of the image to pull

amoni.api.run_service(name: str, remove: bool = True) None

Run a given service

Parameters:

name – The name of the service to start

amoni.api.set_app(name: str) None

Set the app to be run by the anvil app server

Parameters:

name – The name of the app

amoni.api.set_dependency(id: str, name: str) None

Set an app to be a dependency

Parameters:
  • id – The id of the dependency app

  • name – The name of the dependency app

amoni.api.start_service(name: str, detach: bool) None

Start a given service

Parameters:
  • name – The name of the service to start

  • detach – Whether to detach from the service console

amoni.api.stop_services() None

Stop all amoni services