Development

Command Line Interface Design

Context level

The repository-service-tuf, in the context perspective, is a command line tool. It sends HTTP requests to repository-service-tuf-api.

Container level

The repository-service-tuf, in the container perspective, is a command line tool that interacts to the repository-service-tuf-api.

repository-service-tuf writes a settings configuration in the file $HOME/.rstuf.ini with login subcommand.

repository-service-tuf writes the payload.json or the specified file with option -f/--file with ceremony subcommand.

repository-service-tuf writes also upon request all the metadata files in metadata folder if used -s/--save``with ``ceremony subcommand.

Component level

• repository_service_tuf package
  • Subpackages
    • repository_service_tuf.cli package
      • Subpackages
      • Module contents
    • repository_service_tuf.helpers package
      • Submodules
      • repository_service_tuf.helpers.api_client module
      • repository_service_tuf.helpers.tuf module
      • Module contents
  • Module contents
• repository_service_tuf.cli package
  • Subpackages
    • repository_service_tuf.cli.admin package
      • Submodules
      • repository_service_tuf.cli.admin.ceremony module
      • repository_service_tuf.cli.admin.login module
      • repository_service_tuf.cli.admin.token module
      • Module contents
  • Module contents
• repository_service_tuf.cli.admin package
  • Submodules
  • repository_service_tuf.cli.admin.ceremony module
    • Key
      • Key.error
      • Key.key
    • PayloadSettings
      • PayloadSettings.roles
      • PayloadSettings.service
    • RoleSettings
      • RoleSettings.expiration
      • RoleSettings.keys
      • RoleSettings.offline_keys
      • RoleSettings.threshold
    • Roles
      • Roles.BIN
      • Roles.BINS
      • Roles.ROOT
      • Roles.SNAPSHOT
      • Roles.TARGETS
      • Roles.TIMESTAMP
    • ServiceSettings
      • ServiceSettings.targets_base_url
      • ServiceSettings.to_dict()
  • repository_service_tuf.cli.admin.login module
  • repository_service_tuf.cli.admin.token module
  • Module contents
• repository_service_tuf.helpers package
  • Submodules
  • repository_service_tuf.helpers.api_client module
    • Login
      • Login.data
      • Login.state
    • Methods
      • Methods.get
      • Methods.post
    • URL
      • URL.bootstrap
      • URL.task
      • URL.token
    • is_logged()
    • request_server()
  • repository_service_tuf.helpers.tuf module
    • RolesKeysInput
      • RolesKeysInput.expiration
      • RolesKeysInput.keys
      • RolesKeysInput.num_of_keys
      • RolesKeysInput.number_hash_prefixes
      • RolesKeysInput.offline_keys
      • RolesKeysInput.paths
      • RolesKeysInput.threshold
      • RolesKeysInput.to_dict()
    • initialize_metadata()
  • Module contents
• repository_service_tuf
  • repository_service_tuf package
    • Subpackages
      • repository_service_tuf.cli package
      • repository_service_tuf.helpers package
    • Module contents