flexlate package

A composable, maintainable system for managing templates

Subpackages

• flexlate.finder package
  • Subpackages
    • flexlate.finder.specific package
      • Submodules
      • flexlate.finder.specific.base module
      • flexlate.finder.specific.cookiecutter module
      • flexlate.finder.specific.copier module
      • flexlate.finder.specific.git module
  • Submodules
  • flexlate.finder.multi module
• flexlate.render package
  • Subpackages
    • flexlate.render.specific package
      • Submodules
      • flexlate.render.specific.base module
      • flexlate.render.specific.cookiecutter module
      • flexlate.render.specific.copier module
  • Submodules
  • flexlate.render.multi module
  • flexlate.render.renderable module
• flexlate.template package
  • Submodules
  • flexlate.template.base module
  • flexlate.template.cookiecutter module
  • flexlate.template.copier module
  • flexlate.template.hashing module
  • flexlate.template.types module
• flexlate.template_config package
  • Submodules
  • flexlate.template_config.base module
  • flexlate.template_config.cookiecutter module
  • flexlate.template_config.copier module
• flexlate.transactions package
  • Submodules
  • flexlate.transactions.transaction module
  • flexlate.transactions.undoer module
• flexlate.update package
  • Submodules
  • flexlate.update.main module
  • flexlate.update.template module

Submodules

flexlate.add_mode module

class flexlate.add_mode.AddMode(value)

Bases: str, enum.Enum

An enumeration.

LOCAL = 'local'

PROJECT = 'project'

USER = 'user'

flexlate.add_mode.get_expanded_out_root(out_root, project_root, render_relative_root_in_output, add_mode)

Return type

Path

flexlate.adder module

class flexlate.adder.Adder

Bases: object

add_template_source(repo, template, transaction, target_version=None, out_root=PosixPath('.'), merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', add_mode=AddMode.LOCAL, remote='origin', config_manager=<flexlate.config_manager.ConfigManager object>)

apply_template_and_add(repo, template, transaction, data=None, out_root=PosixPath('.'), add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', no_input=False, remote='origin', config_manager=<flexlate.config_manager.ConfigManager object>, updater=<flexlate.update.main.Updater object>, renderer=<flexlate.render.multi.MultiRenderer object>)

init_project_and_add_to_branches(repo, default_add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', user=False, remote='origin', config_manager=<flexlate.config_manager.ConfigManager object>)

init_project_from_template_source_path(template, transaction, path=PosixPath('.'), target_version=None, data=None, default_folder_name='project', default_add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', remote='origin', no_input=False, config_manager=<flexlate.config_manager.ConfigManager object>, updater=<flexlate.update.main.Updater object>, renderer=<flexlate.render.multi.MultiRenderer object>, syncer=<flexlate.syncer.Syncer object>)

Return type

str

flexlate.bootstrapper module

class flexlate.bootstrapper.Bootstrapper

Bases: object

bootstrap_flexlate_init_from_existing_template(repo, template, transaction, target_version=None, data=None, default_add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', remote='origin', no_input=False, adder=<flexlate.adder.Adder object>, config_manager=<flexlate.config_manager.ConfigManager object>, renderer=<flexlate.render.multi.MultiRenderer object>, updater=<flexlate.update.main.Updater object>, user_config_manager=<flexlate.user_config_manager.UserConfigManager object>)

flexlate.branch_update module

flexlate.branch_update.abort_merge_and_reset_flexlate_branches(repo, current_branch, merged_branch_sha=None, template_branch_sha=None, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates')

flexlate.branch_update.get_flexlate_branch_name(repo, base_branch_name)

Return type

str

flexlate.branch_update.get_flexlate_branch_name_for_feature_branch(feature_branch, base_branch_name)

Return type

str

flexlate.branch_update.modify_files_via_branches_and_temp_repo(file_operation, repo, commit_message, out_root, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', remote='origin')

flexlate.branch_update.prompt_to_fix_conflicts_and_reset_on_abort_return_aborted(repo, current_branch, merged_branch_sha, template_branch_sha, merged_branch_name, template_branch_name)

Return type

bool

flexlate.branch_update.undo_transaction_in_flexlate_branches(repo, transaction, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates')

flexlate.checker module

class flexlate.checker.CheckResult(**data)

Bases: pydantic.main.BaseModel

existing_version: str

property has_update: bool

Return type

bool

latest_version: str

source_name: str

class flexlate.checker.CheckResults(**data)

Bases: pydantic.main.BaseModel

property has_updates: bool

Return type

bool

results: List[flexlate.checker.CheckResult]

property update_version_dict: Dict[str, str]

Return type

Dict[str, str]

property updates: List[flexlate.checker.CheckResult]

Return type

List[CheckResult]

class flexlate.checker.CheckResultsRenderable(**data)

Bases: pydantic.main.BaseModel

results: List[flexlate.checker.CheckResult]

class flexlate.checker.Checker

Bases: object

find_new_versions_for_template_sources(names=None, project_root=PosixPath('.'), config_manager=<flexlate.config_manager.ConfigManager object>, finder=<flexlate.finder.multi.MultiFinder object>)

Return type

CheckResults

flexlate.cli module

flexlate.cli.add_source(path=typer.Argument, name=typer.Argument, version=typer.Option, template_root=typer.Option, add_mode=typer.Option, quiet=typer.Option)

Adds a new template source, so that files can be generated from it.

See the [user guide on adding new templates within an existing project]( https://nickderobertis.github.io/flexlate/tutorial/get-started/add-to-project.html ) for more details.

flexlate.cli.bootstrap(template_path=typer.Argument, path=typer.Argument, version=typer.Option, no_input=typer.Option, quiet=typer.Option, default_add_mode=typer.Option, remote=typer.Option, merged_branch_name=typer.Option, template_branch_name=typer.Option)

Sets up a Flexlate project from an existing project that was already generated by another tool such as Cookiecutter or Copier.

See the user guide on [adding Flexlate to a project already generated from a template]( https://nickderobertis.github.io/flexlate/tutorial/get-started/existing-project.html ) for more information.

flexlate.cli.check(names=typer.Argument, path=typer.Option, quiet=typer.Option)

Checks whether there are any updates available for the current template sources

Displays a tabular output of the templates that need to be updated. It will also exist with code 1 when updates are available so that it is easy to use in scripting.

See the user guide on [updating templates]( https://nickderobertis.github.io/flexlate/tutorial/updating.html ), especially [the section about checking for updates]( https://nickderobertis.github.io/flexlate/tutorial/updating.html#checking-for-updates ), for more information.

flexlate.cli.generate_applied_template(name=typer.Argument, template_root=typer.Argument, add_mode=typer.Option, no_input=typer.Option, quiet=typer.Option)

Applies a template to a given location, and stores it in config so it can be updated

See the [user guide on adding new templates within an existing project]( https://nickderobertis.github.io/flexlate/tutorial/get-started/add-to-project.html ) for more details.

flexlate.cli.init_project(path=typer.Argument, default_add_mode=typer.Option, merged_branch_name=typer.Option, template_branch_name=typer.Option, user=typer.Option, remote=typer.Option, quiet=typer.Option)

Initializes a flexlate project. This must be run before other commands

See the user guide on [adding templates within an existing project]( https://nickderobertis.github.io/flexlate/tutorial/get-started/add-to-project.html ) for more details.

flexlate.cli.init_project_from(template_path=typer.Argument, path=typer.Argument, version=typer.Option, folder_name=typer.Option, no_input=typer.Option, quiet=typer.Option, default_add_mode=typer.Option, remote=typer.Option, merged_branch_name=typer.Option, template_branch_name=typer.Option)

Generates a project from a template and sets it up as a Flexlate project.

Note that this will also create a new folder and initialize a git repository in it before adding the Flexlate output.

See the user guide on [creating a new project with Flexlate]( https://nickderobertis.github.io/flexlate/tutorial/get-started/new-project.html ) for more information.

flexlate.cli.merge(branch_name=typer.Argument, delete=typer.Option, path=typer.Option, quiet=typer.Option)

Merges feature flexlate branches into the main flexlate branches

Feature flexlate branches should be merged into main flexlate branches when the corresponding feature branch is merged into the repo’s main branch. This command provides a convenient way to do so.

See the user guide on [saving Flexlate updates]( https://nickderobertis.github.io/flexlate/tutorial/saving.html ), especially [the section about locally merging branches]( https://nickderobertis.github.io/flexlate/tutorial/saving.html#locally-merging-branches ), for more information.

flexlate.cli.pre_execute(version=typer.Option)

flexlate.cli.push_feature(feature_branch=typer.Argument, remote=typer.Option, path=typer.Option, quiet=typer.Option)

Pushes feature Flexlate branches to remote

See the user guide on [saving Flexlate updates]( https://nickderobertis.github.io/flexlate/tutorial/saving.html ), especially [the section about pushing changes with a PR workflow]( https://nickderobertis.github.io/flexlate/tutorial/saving.html#push-your-flexlate-feature-branch-changes ), for more information.

flexlate.cli.push_main(remote=typer.Option, path=typer.Option, quiet=typer.Option)

Pushes main Flexlate branches to remote

See the user guide on [saving Flexlate updates]( https://nickderobertis.github.io/flexlate/tutorial/saving.html ), especially [the section about pushing with a local workflow]( https://nickderobertis.github.io/flexlate/tutorial/saving.html#push-your-flexlate-main-branch-changes ), for more information.

flexlate.cli.remove_template_output(template_name=typer.Argument, template_root=typer.Argument, quiet=typer.Option)

Removes an applied template output

flexlate.cli.remove_template_source(template_name=typer.Argument, template_root=typer.Option, quiet=typer.Option)

Removes a template source, so that files can no longer be generated from it.

flexlate.cli.sync(path=typer.Argument, prompt=typer.Option, quiet=typer.Option)

Syncs manual changes to the flexlate branches, and updates templates accordingly.

This is useful if you want to move or modify flexlate configs after they are created, but there is no command in the CLI for it.

Note: Be sure to commit your changes before running sync

See the user guide on [making arbitrary changes]( https://nickderobertis.github.io/flexlate/tutorial/arbitrary-changes.html ) for more information.

flexlate.cli.undo(num_operations=typer.Argument, path=typer.Option, quiet=typer.Option)

Undoes the last flexlate operation, like ctrl/cmd + z for flexlate. Note that this modifies the git history, discarding the last commits. It has protections against deleting user commits but you should only use this on a feature branch.

See the user guide on [undoing Flexlate operations]( https://nickderobertis.github.io/flexlate/tutorial/undoing.html ) for more information.

flexlate.cli.update_template_source_target_version(name=typer.Argument, version=typer.Argument, path=typer.Option, add_mode=typer.Option, quiet=typer.Option)

Updates a target version for a template source.

If no version is passed, it will remove the targeting so it will always update.

See the user guide on [updating templates]( https://nickderobertis.github.io/flexlate/tutorial/updating.html ), especially [the section about changing target version]( https://nickderobertis.github.io/flexlate/tutorial/updating.html#change-target-version ), for more information.

flexlate.cli.update_templates(names=typer.Argument, no_input=typer.Option, abort_on_conflict=typer.Option, no_cleanup=typer.Option, quiet=typer.Option, path=typer.Option)

Updates applied templates in the project to the newest versions available that still satisfy source target versions

See the user guide on [updating templates]( https://nickderobertis.github.io/flexlate/tutorial/updating.html ) for more information.

flexlate.cli_utils module

flexlate.cli_utils.confirm_user(prompt)

Return type

bool

flexlate.config module

class flexlate.config.AppliedTemplateConfig(*, name: str, data: Dict[str, Any], version: str, add_mode: flexlate.add_mode.AddMode, root: pathlib.Path = PosixPath('.'))

Bases: pydantic.main.BaseModel

__init__(**kwargs)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

add_mode: flexlate.add_mode.AddMode

data: Dict[str, Any]

name: str

root: pathlib.Path

version: str

class flexlate.config.AppliedTemplateWithSource(**data)

Bases: pydantic.main.BaseModel

applied_template: flexlate.config.AppliedTemplateConfig

applied_template_config_path: pathlib.Path

index: int

source: flexlate.config.TemplateSource

source_config_path: pathlib.Path

to_template_and_data()

Return type

Tuple[Template, Dict[str, Any]]

class flexlate.config.FlexlateConfig(_env_file='<object object>', _env_file_encoding=None, _env_nested_delimiter=None, _secrets_dir=None, **values)

Bases: pyappconf.model.BaseConfig

class Config

Bases: object

extra = 'allow'

add_applied_template(applied_template, config_location)

Return type

None

add_template_source(template_source, config_location)

Return type

None

applied_templates: List[flexlate.config.AppliedTemplateConfig]

property child_configs: List[flexlate.config.FlexlateConfig]

Return type

List[FlexlateConfig]

property empty: bool

Return type

bool

classmethod from_dir_including_nested(root, adjust_applied_paths=True)

Return type

FlexlateConfig

classmethod from_multiple(configs)

Return type

FlexlateConfig

get_applied_template_by_update(update)

Return type

AppliedTemplateConfig

get_num_applied_templates_in_child_config(child_config_path)

classmethod load(path=None)

Return type

FlexlateConfig

move_applied_template(template_name, config_path, new_config_path, render_relative_root_in_output, project_root=PosixPath('.'), out_root=PosixPath('.'), orig_project_root=PosixPath('.'))

move_template_source(template_name, config_path, new_config_path)

remove_applied_template(template_name, config_location, project_root=PosixPath('.'), out_root=PosixPath('.'), orig_project_root=PosixPath('.'))

Return type

None

remove_template_source(template_name, config_location)

Return type

None

save(serializer_kwargs=None, **kwargs)

classmethod template_name_must_be_unique(v)

template_sources: List[flexlate.config.TemplateSource]

property template_sources_dict: Dict[str, flexlate.config.TemplateSource]

Return type

Dict[str, TemplateSource]

update_applied_template(updater, config_location, index)

Return type

None

update_template_source(updater, name)

Return type

None

update_template_sources(updater, names=None)

Return type

None

class flexlate.config.FlexlateProjectConfig(_env_file='<object object>', _env_file_encoding=None, _env_nested_delimiter=None, _secrets_dir=None, **values)

Bases: pyappconf.model.BaseConfig

get_project_for_path(path=PosixPath('.'))

Return type

ProjectConfig

projects: List[flexlate.config.ProjectConfig]

class flexlate.config.ProjectConfig(**data)

Bases: pydantic.main.BaseModel

default_add_mode: flexlate.add_mode.AddMode

merged_branch_name: str

path: pathlib.Path

remote: str

template_branch_name: str

class flexlate.config.TemplateSource(**data)

Bases: pydantic.main.BaseModel

property absolute_local_path: pathlib.Path

Return type

Path

classmethod from_template(template, target_version=None)

Return type

TemplateSource

git_url: Optional[str]

property is_local_template: bool

Return type

bool

name: str

path: str

render_relative_root_in_output: pathlib.Path

render_relative_root_in_template: pathlib.Path

target_version: Optional[str]

to_template(version=None, finder=<flexlate.finder.multi.MultiFinder object>)

Return type

Template

type: flexlate.template.types.TemplateType

property update_location: Union[str, pathlib.Path]

Return type

Union[str, Path]

version: Optional[str]

class flexlate.config.TemplateSourceWithTemplates(**data)

Bases: pydantic.main.BaseModel

class Config

Bases: object

arbitrary_types_allowed = True

source: flexlate.config.TemplateSource

templates: List[flexlate.template.base.Template]

flexlate.config_manager module

class flexlate.config_manager.ConfigManager

Bases: object

add_applied_template(template, config_path, add_mode, data=None, project_root=PosixPath('.'), out_root=PosixPath('.'))

add_project(path=PosixPath('.'), default_add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', user=False, remote='origin')

add_template_source(template, config_path, target_version=None, project_root=PosixPath('.'))

get_all_renderables(relative_to=None, project_root=PosixPath('.'), config=None)

Return type

List[Renderable]

get_all_templates(relative_to=None, project_root=PosixPath('.'), config=None)

Return type

List[Template]

get_applied_templates_with_sources(relative_to=None, project_root=PosixPath('.'), config=None)

Return type

List[AppliedTemplateWithSource]

get_data_for_updates(updates, project_root=PosixPath('.'), config=None)

Return type

List[Dict[str, Any]]

get_no_op_updates(project_root=PosixPath('.'), config=None)

Return type

List[TemplateUpdate]

get_num_applied_templates_in_child_config(child_config_path, project_root=PosixPath('.'))

get_renderables_for_updates(updates, project_root=PosixPath('.'), adjust_root=True)

Return type

List[Renderable]

get_sources_with_templates(templates, project_root=PosixPath('.'), config=None)

Return type

List[TemplateSourceWithTemplates]

get_template_by_name(name, project_root=PosixPath('.'), config=None)

Return type

Template

get_template_sources(names=None, project_root=PosixPath('.'), config=None)

Return type

List[TemplateSource]

load_config(project_root=PosixPath('.'), adjust_applied_paths=True)

Return type

FlexlateConfig

load_project_config(path=PosixPath('.'))

Return type

ProjectConfig

load_projects_config(path=PosixPath('.'))

Return type

FlexlateProjectConfig

load_specific_projects_config(path=PosixPath('.'), user=False)

move_applied_template(template_name, config_path, new_config_path, render_relative_root_in_output, project_root=PosixPath('.'), out_root=PosixPath('.'), orig_project_root=PosixPath('.'))

move_local_applied_templates_if_necessary_produce_new_updates(updates, project_root=PosixPath('.'), orig_project_root=PosixPath('.'), renderer=<flexlate.render.multi.MultiRenderer object>)

Return type

List[TemplateUpdate]

move_template_source(template_name, config_path, new_config_path, project_root=PosixPath('.'))

remove_applied_template(template_name, config_path, project_root=PosixPath('.'), out_root=PosixPath('.'), orig_project_root=PosixPath('.'))

Parameters

• template_name (str) –

• config_path (Path) –

• project_root (Path) – The root of the current working project (may be a temp directory)

• out_root (Path) –

• orig_project_root (Path) – The root of the user’s project (always stays the same, even when working in a temp directory)

Returns

remove_template_source(template_name, config_path, project_root=PosixPath('.'))

save_config(config)

save_projects_config(config)

template_source_exists(name, project_root=PosixPath('.'), config=None)

Return type

bool

update_template_source_version(name, target_version=None, project_root=PosixPath('.'), config=None)

update_template_sources(names, updater, project_root=PosixPath('.'), config=None)

update_templates(updates, project_root=PosixPath('.'), use_template_source_path=True)

flexlate.config_manager.determine_config_path_from_roots_and_add_mode(out_root=PosixPath('.'), project_root=PosixPath('.'), add_mode=AddMode.LOCAL)

Return type

Path

flexlate.constants module

flexlate.error_handler module

flexlate.error_handler.simple_output_for_exceptions(*exceptions)

flexlate.exc module

exception flexlate.exc.CannotFindAppliedTemplateException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.CannotFindClonedTemplateException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.CannotFindCorrectMergeParentException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.CannotFindMergeForTransactionException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.CannotFindTemplateSourceException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.CannotLoadConfigException

Bases: flexlate.exc.FlexlateConfigException

exception flexlate.exc.CannotParseCommitMessageFlexlateTransaction

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.CannotRemoveAppliedTemplateException

Bases: flexlate.exc.CannotRemoveConfigItemException

exception flexlate.exc.CannotRemoveConfigItemException

Bases: flexlate.exc.FlexlateConfigException

exception flexlate.exc.CannotRemoveTemplateSourceException

Bases: flexlate.exc.CannotRemoveConfigItemException

exception flexlate.exc.ExpectedMergeCommitException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.FlexlateConfigException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.FlexlateConfigFileNotExistsException

Bases: flexlate.exc.CannotLoadConfigException

exception flexlate.exc.FlexlateException

Bases: Exception

exception flexlate.exc.FlexlateGitException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.FlexlateProjectConfigFileNotExistsException

Bases: flexlate.exc.CannotLoadConfigException

exception flexlate.exc.FlexlateSyncException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.FlexlateTemplateException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.FlexlateTransactionException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.FlexlateUpdateException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.GitRepoDirtyException

Bases: flexlate.exc.FlexlateGitException

exception flexlate.exc.GitRepoHasNoCommitsException

Bases: flexlate.exc.FlexlateGitException

exception flexlate.exc.InvalidNumberOfTransactionsException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.InvalidTemplateClassException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.InvalidTemplateDataException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.InvalidTemplatePathException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.InvalidTemplateTypeException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.LastCommitWasNotByFlexlateException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.MergeCommitIsNotMergingAFlexlateTransactionException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.MergeConflictsAndAbortException

Bases: flexlate.exc.FlexlateUpdateException

exception flexlate.exc.RendererNotFoundException

Bases: flexlate.exc.FlexlateException

exception flexlate.exc.TemplateLookupException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.TemplateNotRegisteredException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.TemplateSourceWithNameAlreadyExistsException

Bases: flexlate.exc.FlexlateTemplateException

exception flexlate.exc.TooFewTransactionsException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.TransactionMismatchBetweenBranchesException

Bases: flexlate.exc.FlexlateTransactionException

exception flexlate.exc.TriedToCommitButNoChangesException

Bases: flexlate.exc.FlexlateGitException

exception flexlate.exc.UnnecessarySyncException

Bases: flexlate.exc.FlexlateSyncException

exception flexlate.exc.UserChangesWouldHaveBeenDeletedException

Bases: flexlate.exc.FlexlateTransactionException

flexlate.ext_git module

flexlate.ext_git.abort_merge(repo)

flexlate.ext_git.assert_repo_is_in_clean_state(repo)

flexlate.ext_git.branch_exists(repo, branch_name)

Return type

bool

flexlate.ext_git.checked_out_template_branch(repo, branch_name, base_branch_name)

flexlate.ext_git.checkout_template_branch(repo, branch_name, base_branch_name)

flexlate.ext_git.checkout_version(repo, version)

flexlate.ext_git.clone_repo_at_version_get_repo_and_name(path, dst_folder, version=None)

Return type

Tuple[Repo, str]

flexlate.ext_git.delete_all_tracked_files(repo)

flexlate.ext_git.delete_local_branch(repo, branch_name)

flexlate.ext_git.fast_forward_branch_without_checkout(repo, base_branch, ff_branch)

flexlate.ext_git.get_branch_sha(repo, branch_name)

Return type

Optional[str]

flexlate.ext_git.get_commits_between_two_commits(repo, start, end)

Return type

List[Commit]

flexlate.ext_git.get_current_version(repo)

Return type

str

flexlate.ext_git.get_merge_conflict_diffs(repo)

Return type

str

flexlate.ext_git.get_repo_remote_name_from_repo(repo)

Return type

str

flexlate.ext_git.list_tracked_files(repo)

Return type

Set[Path]

flexlate.ext_git.merge_branch_into_current(repo, branch_name, allow_conflicts=True)

flexlate.ext_git.push_to_remote(repo, branch_name, remote_name='origin')

flexlate.ext_git.repo_has_merge_conflicts(repo)

Return type

bool

flexlate.ext_git.reset_branch_to_commit_without_checkout(repo, branch_name, commit_sha=None)

flexlate.ext_git.reset_current_branch_to_commit(repo, commit)

flexlate.ext_git.restore_initial_commit_files(repo)

flexlate.ext_git.stage_and_commit_all(repo, commit_message)

flexlate.ext_git.temp_repo_that_pushes_to_branch(repo, branch_name, base_branch_name, delete_tracked_files=False, copy_current_configs=True, force_push=False, additional_branches=(), remote='origin')

Return type

AbstractContextManager[Repo]

flexlate.ext_git.update_local_branches_from_remote_without_checkout(repo, branch_names, remote='origin')

flexlate.get_version module

flexlate.get_version.get_flexlate_version()

Return type

str

flexlate.logger module

class flexlate.logger.LogLevel(value)

Bases: str, enum.Enum

An enumeration.

DEBUG = 'DEBUG'

INFO = 'INFO'

class flexlate.logger.LoggingConfig(_env_file='<object object>', _env_file_encoding=None, _env_nested_delimiter=None, _secrets_dir=None, **values)

Bases: pydantic.env_settings.BaseSettings

class Config

Bases: object

env_prefix = 'FLEXLATE_LOG_'

classmethod cast_log_level(v)

level: flexlate.logger.LogLevel

flexlate.main module

class flexlate.main.Flexlate(quiet=False, adder=<flexlate.adder.Adder object>, bootstrapper=<flexlate.bootstrapper.Bootstrapper object>, checker=<flexlate.checker.Checker object>, remover=<flexlate.remover.Remover object>, config_manager=<flexlate.config_manager.ConfigManager object>, merger=<flexlate.merger.Merger object>, finder=<flexlate.finder.multi.MultiFinder object>, pusher=<flexlate.pusher.Pusher object>, renderer=<flexlate.render.multi.MultiRenderer object>, syncer=<flexlate.syncer.Syncer object>, undoer=<flexlate.transactions.undoer.Undoer object>, updater=<flexlate.update.main.Updater object>, user_config_manager=<flexlate.user_config_manager.UserConfigManager object>)

Bases: object

__init__(quiet=False, adder=<flexlate.adder.Adder object>, bootstrapper=<flexlate.bootstrapper.Bootstrapper object>, checker=<flexlate.checker.Checker object>, remover=<flexlate.remover.Remover object>, config_manager=<flexlate.config_manager.ConfigManager object>, merger=<flexlate.merger.Merger object>, finder=<flexlate.finder.multi.MultiFinder object>, pusher=<flexlate.pusher.Pusher object>, renderer=<flexlate.render.multi.MultiRenderer object>, syncer=<flexlate.syncer.Syncer object>, undoer=<flexlate.transactions.undoer.Undoer object>, updater=<flexlate.update.main.Updater object>, user_config_manager=<flexlate.user_config_manager.UserConfigManager object>)

add_template_source(path, name=None, target_version=None, template_root=PosixPath('.'), add_mode=None)

apply_template_and_add(name, data=None, out_root=PosixPath('.'), add_mode=None, no_input=False)

bootstrap_flexlate_init_from_existing_template(template_path, path=PosixPath('.'), template_version=None, data=None, default_add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', remote='origin', no_input=False)

check(names=None, project_path=PosixPath('.'))

Return type

CheckResults

init_project(path=PosixPath('.'), default_add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', user=False, remote='origin')

init_project_from(template_path, path=PosixPath('.'), template_version=None, data=None, default_folder_name='project', no_input=False, default_add_mode=AddMode.LOCAL, remote='origin', merged_branch_name='flexlate-output', template_branch_name='flexlate-templates')

Return type

str

merge_flexlate_branches(branch_name=None, delete=True, project_path=PosixPath('.'))

push_feature_flexlate_branches(feature_branch=None, remote='origin', project_path=PosixPath('.'))

push_main_flexlate_branches(remote=None, project_path=PosixPath('.'))

remove_applied_template_and_output(template_name, out_root=PosixPath('.'))

remove_template_source(template_name, template_root=PosixPath('.'))

sync(prompt=False, project_path=PosixPath('.'))

undo(num_operations=1, project_path=PosixPath('.'))

update(names=None, data=None, no_input=False, abort_on_conflict=False, no_cleanup=False, project_path=PosixPath('.'))

update_template_source_target_version(name, target_version=None, add_mode=None, project_path=PosixPath('.'))

flexlate.merger module

class flexlate.merger.Merger

Bases: object

merge_flexlate_branches(repo, branch_name=None, delete=True, merged_branch_name='flexlate-output', template_branch_name='flexlate-templates')

flexlate.path_ops module

flexlate.path_ops.change_directory_to(path)

flexlate.path_ops.copy_flexlate_configs(src, dst, root)

flexlate.path_ops.location_relative_to_new_parent(path, orig_parent, new_parent, path_is_relative_to=None)

Return type

Path

flexlate.path_ops.make_absolute_path_from_possibly_relative_to_another_path(path, possibly_relative_to)

Return type

Path

flexlate.path_ops.make_all_dirs(paths)

flexlate.path_ops.make_func_that_creates_cwd_and_out_root_before_running(out_root, func)

When switching branches, the CWD or target out_root may no longer exist. Pass a function to this function to create a function that creates those directories as needed before running the logic

flexlate.pusher module

class flexlate.pusher.Pusher

Bases: object

push_feature_flexlate_branches(repo, feature_branch=None, remote='origin', merged_branch_name='flexlate-output', template_branch_name='flexlate-templates')

push_main_flexlate_branches(repo, remote='origin', merged_branch_name='flexlate-output', template_branch_name='flexlate-templates')

flexlate.remover module

class flexlate.remover.Remover

Bases: object

remove_applied_template_and_output(repo, template_name, transaction, out_root=PosixPath('.'), add_mode=AddMode.LOCAL, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', remote='origin', config_manager=<flexlate.config_manager.ConfigManager object>, updater=<flexlate.update.main.Updater object>, renderer=<flexlate.render.multi.MultiRenderer object>)

remove_template_source(repo, template_name, transaction, out_root=PosixPath('.'), merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', add_mode=AddMode.LOCAL, remote='origin', config_manager=<flexlate.config_manager.ConfigManager object>)

flexlate.styles module

flexlate.styles.print_styled(message, style)

flexlate.styles.styled(message, style)

Return type

str

flexlate.syncer module

class flexlate.syncer.Syncer

Bases: object

sync_local_changes_to_flexlate_branches(repo, transaction, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', no_input=False, remote='origin', updater=<flexlate.update.main.Updater object>, renderer=<flexlate.render.multi.MultiRenderer object>, config_manager=<flexlate.config_manager.ConfigManager object>)

flexlate.temp_path module

flexlate.temp_path.create_temp_path()

Returns a temporary folder path

Use this instead of tempfile.TemporaryDirectory because: 1. That returns a string and not a path 2. On MacOS, the temp directory has a symlink. This resolves the symlink so that

there won’t be any mismatch in resolved paths.

3. On Windows, the temp directory can fail to delete with a PermissionError. This function will try to delete the temp directory, but if it fails with an error it will just ignore it.

Return type

Iterator[Path]

flexlate.template_data module

flexlate.template_data.merge_data(overrides, defaults)

Return type

List[Dict[str, Any]]

flexlate.template_path module

flexlate.template_path.get_local_repo_path_and_name_cloning_if_repo_url(path, version=None, dst_folder=None)

Return type

Tuple[Path, str]

flexlate.template_path.is_local_template(path)

Return type

bool

flexlate.template_path.is_repo_url(value)

Return True if value is a repository URL.

flexlate.types module

flexlate.user_config_manager module

class flexlate.user_config_manager.UserConfigManager

Bases: object

A higher-level version of the config manager that also works with flexlate branches

ConfigManager is the lower-level version that does not care about branches

update_template_source_target_version(name, target_version, repo, transaction, project_path=PosixPath('.'), add_mode=None, merged_branch_name='flexlate-output', base_merged_branch_name='flexlate-output', template_branch_name='flexlate-templates', base_template_branch_name='flexlate-templates', remote='origin', config_manager=<flexlate.config_manager.ConfigManager object>)