yambs package

Subpackages

• yambs.aggregation package
  • Module contents
    • collect_files()
    • compile_sources()
    • headers()
    • populate_sources()
    • sources_headers()
• yambs.commands package
  • Submodules
  • yambs.commands.all module
    • commands()
  • yambs.commands.common module
    • add_common_args()
    • add_config_arg()
    • handle_build()
    • log_package()
    • run_watch()
  • yambs.commands.compile_config module
    • add_compile_config_cmd()
    • compile_config_cmd()
  • yambs.commands.dist module
    • add_dist_cmd()
    • dist_cmd()
  • yambs.commands.download module
    • add_download_cmd()
    • download_cmd()
  • yambs.commands.gen module
    • add_gen_cmd()
    • gen_cmd()
  • yambs.commands.native module
    • add_native_cmd()
    • native_cmd()
  • yambs.commands.uf2conv module
    • add_uf2conv_cmd()
    • error()
    • uf2conv_cmd()
  • Module contents
• yambs.config package
  • Submodules
  • yambs.config.board module
    • Architecture
      • Architecture.extra_cflags
      • Architecture.from_dict()
      • Architecture.name
      • Architecture.toolchain
    • Board
      • Board.apps
      • Board.build
      • Board.chip
      • Board.extra_cflags
      • Board.extra_dirs
      • Board.from_dict()
      • Board.name
      • Board.targets
    • Chip
      • Chip.architecture
      • Chip.cpu
      • Chip.extra_cflags
      • Chip.from_dict()
      • Chip.jlink
      • Chip.name
  • yambs.config.common module
    • CommonConfig
      • CommonConfig.build_root
      • CommonConfig.data
      • CommonConfig.dependencies
      • CommonConfig.directory()
      • CommonConfig.dist_root
      • CommonConfig.file
      • CommonConfig.init()
      • CommonConfig.load()
      • CommonConfig.ninja_root
      • CommonConfig.root
      • CommonConfig.src_root
      • CommonConfig.third_party_root
      • CommonConfig.third_party_script
    • Project
      • Project.create()
      • Project.major
      • Project.minor
      • Project.name
      • Project.owner
      • Project.patch
      • Project.repo
      • Project.version
  • yambs.config.native module
    • Native
      • Native.has_variant()
    • load_native()
  • Module contents
    • Config
      • Config.board_data
      • Config.boards()
      • Config.boards_by_name
      • Config.init()
• yambs.dependency package
  • Subpackages
    • yambs.dependency.handlers package
      • Subpackages
      • Submodules
      • yambs.dependency.handlers.types module
      • Module contents
  • Submodules
  • yambs.dependency.config module
    • Dependency
      • Dependency.init()
    • DependencyKind
      • DependencyKind.YAMBS
    • DependencySource
      • DependencySource.DIRECTORY
      • DependencySource.GITHUB
  • yambs.dependency.github module
    • GithubDependency
      • GithubDependency.download_release_assets()
    • default_filt()
    • download_file_if_missing()
    • ensure_extracted()
  • yambs.dependency.manager module
    • DependencyManager
      • DependencyManager.audit()
      • DependencyManager.info()
      • DependencyManager.save()
    • write_third_party_script()
  • yambs.dependency.state module
    • DependencyState
      • DependencyState.INIT
  • Module contents
• yambs.dist package
  • Module contents
    • copy_source_tree()
    • dist_metadata()
    • make_archives()
• yambs.environment package
  • Submodules
  • yambs.environment.native module
    • NativeBuildEnvironment
      • NativeBuildEnvironment.generate()
      • NativeBuildEnvironment.render()
      • NativeBuildEnvironment.write_app_rules()
      • NativeBuildEnvironment.write_compile_line()
      • NativeBuildEnvironment.write_source_rules()
      • NativeBuildEnvironment.write_static_library_rule()
      • NativeBuildEnvironment.write_third_party_line()
  • Module contents
    • BuildEnvironment
      • BuildEnvironment.first_party_sources_headers()
      • BuildEnvironment.set_board_sources()
    • SourceSets
      • SourceSets.apps
      • SourceSets.implicit_sources()
      • SourceSets.link_sources()
      • SourceSets.regular
      • SourceSets.sources()
• yambs.generate package
  • Subpackages
    • yambs.generate.ninja package
      • Submodules
      • yambs.generate.ninja.format module
      • Module contents
  • Submodules
  • yambs.generate.architectures module
    • generate()
  • yambs.generate.boards module
    • add_dir()
    • create_paths_dict()
    • generate()
    • write_sources()
  • yambs.generate.chips module
    • generate()
  • yambs.generate.common module
    • get_jinja()
    • render_template()
  • yambs.generate.toolchains module
    • generate()
  • yambs.generate.variants module
    • generate()
    • modified_variant_data()
  • Module contents
    • create_board_apps()
    • generate()
• yambs.github package
  • Module contents
    • Github
    • check_api_token()
    • github_url()
    • release_data()
    • repo_release_api_url()
    • validate_release()
• yambs.translation package
  • Module contents
    • SourceTranslator
      • SourceTranslator.dest
      • SourceTranslator.generated_header
      • SourceTranslator.gets_linked
      • SourceTranslator.output()
      • SourceTranslator.output_extension
      • SourceTranslator.rule
      • SourceTranslator.translate()
      • SourceTranslator.write()
    • get_translator()
    • is_header()
    • is_source()
• yambs.uf2 package
  • Module contents
    • Block
      • Block.encode()
    • board_id()
    • convert_from_hex_to_uf2()
    • convert_from_uf2()
    • convert_to_carray()
    • convert_to_uf2()
    • get_drives()
    • is_hex()
    • is_uf2()
    • list_drives()
    • load_families()
    • to_str()
    • write_file()

Submodules

yambs.app module

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

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

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

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

Execute the requested task.

yambs.entry module

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

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

Program entry-point.

yambs.paths module

A module implementing some file-system path utilities.

yambs.paths.combine_if_not_absolute(root: Path, candidate: Path | str | None) → Path

libre-embedded/ifgen

yambs.paths.resolve_build_dir(build_root: Path, variant: str, path: Path) → Path

Resolve the build-directory variable in a path.

yambs.schemas module

A module for working with schemas belonging to this package.

class yambs.schemas.YambsDictCodec(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 = {'entry_common': <vcorelib.schemas.json.JsonSchema object>, 'Config': <vcorelib.schemas.json.JsonSchema object>, 'Github': <vcorelib.schemas.json.JsonSchema object>, 'Native': <vcorelib.schemas.json.JsonSchema object>, 'Project': <vcorelib.schemas.json.JsonSchema object>, 'CommonConfig': <vcorelib.schemas.json.JsonSchema object>, 'Chip': <vcorelib.schemas.json.JsonSchema object>, 'Variant': <vcorelib.schemas.json.JsonSchema object>, 'Toolchain': <vcorelib.schemas.json.JsonSchema object>, 'Architecture': <vcorelib.schemas.json.JsonSchema object>, 'toolchain_common': <vcorelib.schemas.json.JsonSchema object>, 'config_common': <vcorelib.schemas.json.JsonSchema object>, 'Board': <vcorelib.schemas.json.JsonSchema object>, 'Dependency': <vcorelib.schemas.json.JsonSchema object>}

Module contents

Useful defaults and other package metadata.