userfs package

Subpackages

• userfs.build package
  • Module contents
    • build()
    • run_process()
• userfs.commands package
  • Submodules
  • userfs.commands.all module
    • commands()
  • userfs.commands.build module
    • add_build_cmd()
    • build_cmd()
  • userfs.commands.common module
    • add_common()
    • get_projects()
    • run_command()
  • userfs.commands.custom module
    • add_custom_cmd()
    • custom_cmd()
  • userfs.commands.fetch module
    • add_fetch_cmd()
    • fetch_cmd()
  • Module contents
• userfs.config package
  • Submodules
  • userfs.config.project module
    • ProjectInteraction
      • ProjectInteraction.BUILD
      • ProjectInteraction.CUSTOM
      • ProjectInteraction.DEPLOY
      • ProjectInteraction.FETCH
      • ProjectInteraction.UPDATE
    • ProjectSpecification
      • ProjectSpecification.attributes
      • ProjectSpecification.from_json()
      • ProjectSpecification.location()
      • ProjectSpecification.logger
      • ProjectSpecification.options
      • ProjectSpecification.path
      • ProjectSpecification.repository
      • ProjectSpecification.source
      • ProjectSpecification.url
  • userfs.config.source module
    • SourceKind
      • SourceKind.GIT
      • SourceKind.SRC
    • SourceSpecification
      • SourceSpecification.attributes
      • SourceSpecification.from_json()
      • SourceSpecification.host
      • SourceSpecification.kind
      • SourceSpecification.port
      • SourceSpecification.protocol
      • SourceSpecification.suffix
      • SourceSpecification.user
  • Module contents
    • Config
      • Config.init()
    • ProjectInteraction
      • ProjectInteraction.BUILD
      • ProjectInteraction.CUSTOM
      • ProjectInteraction.DEPLOY
      • ProjectInteraction.FETCH
      • ProjectInteraction.UPDATE
    • ProjectSpecification
      • ProjectSpecification.attributes
      • ProjectSpecification.from_json()
      • ProjectSpecification.location()
      • ProjectSpecification.logger
      • ProjectSpecification.options
      • ProjectSpecification.path
      • ProjectSpecification.repository
      • ProjectSpecification.source
      • ProjectSpecification.url
    • SourceKind
      • SourceKind.GIT
      • SourceKind.SRC
    • SourceSpecification
      • SourceSpecification.attributes
      • SourceSpecification.from_json()
      • SourceSpecification.host
      • SourceSpecification.kind
      • SourceSpecification.port
      • SourceSpecification.protocol
      • SourceSpecification.suffix
      • SourceSpecification.user
    • load_config()
• userfs.deploy package
  • Module contents
    • deploy()
• userfs.fetch package
  • Module contents
    • fetch()
• userfs.hooks package
  • Module contents
    • get_hooks()
• userfs.project package
  • Module contents
    • ProjectInteractionTask
      • ProjectInteractionTask.cli_options
      • ProjectInteractionTask.hooks
      • ProjectInteractionTask.hooks_only
      • ProjectInteractionTask.interact()
      • ProjectInteractionTask.kind
      • ProjectInteractionTask.project
      • ProjectInteractionTask.root
    • execute_interactions()
    • interact()
• userfs.update package
  • Module contents
    • update()

Submodules

userfs.app module

This package’s command-line entry-point application.

userfs.app.add_app_args(parser: ArgumentParser) → None

Add application-specific arguments to the command-line parser.

userfs.app.entry(args: Namespace) → int

Execute the requested task.

userfs.entry module

This package’s command-line entry-point (boilerplate).

userfs.entry.main(argv: List[str] = None) → int

Program entry-point.

userfs.paths module

A module for working with the Python search path.

userfs.paths.paths_added(paths: List[Path]) → Iterator[None]

Add search paths to sys.path as a context manager.

userfs.schemas module

A module for working with schemas belonging to this package.

class userfs.schemas.UserfsDictCodec(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)

Bases: DictCodec

A simple wrapper for package classes that want to implement DictCodec.

default_schemas: SchemaMap | None = {'SourceSpecification': <vcorelib.schemas.json.JsonSchema object>, 'Config': <vcorelib.schemas.json.JsonSchema object>, 'ProjectSpecification': <vcorelib.schemas.json.JsonSchema object>}

Module contents

Useful defaults and other package metadata.