pyscaffold

• pyscaffold package
  • Subpackages
    • pyscaffold.extensions package
      • Submodules
      • pyscaffold.extensions.cirrus module
      • pyscaffold.extensions.config module
      • pyscaffold.extensions.github_actions module
      • pyscaffold.extensions.gitlab_ci module
      • pyscaffold.extensions.interactive module
      • pyscaffold.extensions.namespace module
      • pyscaffold.extensions.no_pyproject module
      • pyscaffold.extensions.no_skeleton module
      • pyscaffold.extensions.no_tox module
      • pyscaffold.extensions.pre_commit module
      • pyscaffold.extensions.venv module
      • Module contents
    • pyscaffold.templates package
      • Module contents
  • Submodules
  • pyscaffold.actions module
    • Action
    • ActionParams
    • DEFAULT
    • ScaffoldOpts
    • discover()
    • get_default_options()
    • init_git()
    • invoke()
    • register()
    • report_done()
    • unregister()
    • verify_options_consistency()
    • verify_project_dir()
  • pyscaffold.api module
    • DEFAULT_OPTIONS
    • NO_CONFIG
    • bootstrap_options()
    • create_project()
  • pyscaffold.cli module
    • add_default_args()
    • add_extension_args()
    • add_log_related_args()
    • get_log_level()
    • list_actions()
    • main()
    • parse_args()
    • run()
    • run_scaffold()
  • pyscaffold.dependencies module
    • BUILD
    • ISOLATED
    • REQ_SPLITTER
    • RUNTIME
    • add()
    • attempt_pkg_name()
    • deduplicate()
    • remove()
    • split()
  • pyscaffold.exceptions module
    • ActionNotFound
    • DirectErrorForUser
    • DirectoryAlreadyExists
    • DirectoryDoesNotExist
    • ErrorLoadingExtension
    • ExtensionNotFound
    • GitDirtyWorkspace
      • GitDirtyWorkspace.DEFAULT_MESSAGE
    • GitNotConfigured
      • GitNotConfigured.DEFAULT_MESSAGE
    • GitNotInstalled
      • GitNotInstalled.DEFAULT_MESSAGE
    • ImpossibleToFindConfigDir
    • InvalidIdentifier
    • NestedRepository
    • NoPyScaffoldProject
      • NoPyScaffoldProject.DEFAULT_MESSAGE
    • PyScaffoldTooOld
      • PyScaffoldTooOld.DEFAULT_MESSAGE
    • ShellCommandException
    • exceptions2exit()
  • pyscaffold.file_system module
    • ERROR_INVALID_NAME
    • chdir()
    • chmod()
    • create_directory()
    • create_file()
    • is_pathname_valid()
    • localize_path()
    • move()
    • on_ro_error()
    • rm_rf()
    • tmpfile()
  • pyscaffold.identification module
    • dasherize()
    • deterministic_name()
    • deterministic_sort()
    • get_id()
    • is_valid_identifier()
    • levenshtein()
    • make_valid_identifier()
    • underscore()
  • pyscaffold.info module
    • CONFIG_FILE
    • GitEnv
      • GitEnv.author_date
      • GitEnv.author_email
      • GitEnv.author_name
      • GitEnv.committer_date
      • GitEnv.committer_email
      • GitEnv.committer_name
    • RAISE_EXCEPTION
    • best_fit_license()
    • check_git()
    • config_dir()
    • config_file()
    • email()
    • get_curr_version()
    • is_git_configured()
    • is_git_installed()
    • is_git_workspace_clean()
    • project()
    • read_pyproject()
    • read_setupcfg()
    • username()
  • pyscaffold.log module
    • ColoredReportFormatter
      • ColoredReportFormatter.ACTIVITY_STYLES
      • ColoredReportFormatter.CONTEXT_PREFIX
      • ColoredReportFormatter.LOG_STYLES
      • ColoredReportFormatter.SUBJECT_STYLES
      • ColoredReportFormatter.TARGET_PREFIX
      • ColoredReportFormatter.format_activity()
      • ColoredReportFormatter.format_default()
      • ColoredReportFormatter.format_subject()
    • DEFAULT_LOGGER
    • ReportFormatter
      • ReportFormatter.ACTIVITY_MAXLEN
      • ReportFormatter.CONTEXT_PREFIX
      • ReportFormatter.SPACING
      • ReportFormatter.TARGET_PREFIX
      • ReportFormatter.create_padding()
      • ReportFormatter.format()
      • ReportFormatter.format_activity()
      • ReportFormatter.format_context()
      • ReportFormatter.format_default()
      • ReportFormatter.format_path()
      • ReportFormatter.format_report()
      • ReportFormatter.format_subject()
      • ReportFormatter.format_target()
    • ReportLogger
      • ReportLogger.nesting
      • ReportLogger.copy()
      • ReportLogger.formatter
      • ReportLogger.handler
      • ReportLogger.indent()
      • ReportLogger.level
      • ReportLogger.process()
      • ReportLogger.propagate
      • ReportLogger.reconfigure()
      • ReportLogger.report()
      • ReportLogger.wrapped
    • logger
  • pyscaffold.operations module
    • FileContents
    • FileOp
    • ScaffoldOpts
    • add_permissions()
    • create()
    • no_overwrite()
    • remove()
    • skip_on_update()
  • pyscaffold.repo module
    • add_tag()
    • get_git_root()
    • git_tree_add()
    • init_commit_repo()
    • is_git_repo()
  • pyscaffold.shell module
    • EDITORS
    • ShellCommand
      • ShellCommand.run()
    • command_exists()
    • edit()
    • get_command()
    • get_editor()
    • get_executable()
    • get_git_cmd()
    • git()
    • join()
    • python
    • shell_command_error2exit_decorator()
  • pyscaffold.structure module
    • AbstractContent
    • ActionParams
    • Leaf
    • Node
    • ReifiedLeaf
    • ResolvedLeaf
    • Structure
    • create_structure()
    • define_structure()
    • ensure()
    • merge()
    • modify()
    • reify_content()
    • reify_leaf()
    • reject()
    • resolve_leaf()
  • pyscaffold.termui module
    • STYLES
    • SYSTEM_SUPPORTS_COLOR
    • curses_available()
    • decorate()
    • init_colorama()
    • isatty()
    • supports_color()
  • pyscaffold.toml module
    • TOMLMapping
    • dumps()
    • loads()
    • setdefault()
  • pyscaffold.update module
    • ALWAYS
    • add_dependencies()
    • add_entrypoints()
    • handover_setup_requires()
    • replace_find_with_find_namespace()
    • update_pyproject_toml()
    • update_setup_cfg()
    • version_migration()
  • Module contents