Welcome to Fabsetup!

Set up and maintain configurations, software installations and other things on a local or remote linux system.

Contents:

• Getting Started
  • Installation
  • Usage
  • Tab Completion
  • Addons
  • Your Addon

• Advanced Usage
  • Interactive Runs
  • Output
  • Outfile
  • Pandoc
    • Add Table of Content
    • HTML File
  • Invoke Task Files and Fabfiles

• Configuration
  • Values
  • Defaults
  • Customization Examples

• Addons
  • Pip Addon
  • Addon Repo
• Create an Addon
  • In a Nutshell
  • En Détail
    • Scaffold
    • Code
    • Documentation
    • CI/CD
    • PyPI
  • More Details
    • Files
    • Git Repositories
    • Downloads
  • Styleguide
    • Cleanliness
    • Comprehensibility
    • Traceability
    • Repetitions
    • Markdown Output

• API
  • version_str()
  • Submodules
    • fabsetup.fabutils
      • fabsetup.fabutils.addon
        • filled_out_template_str()
        • filled_out_template()
        • template_context()
        • Addon
      • fabsetup.fabutils.queries
        • interactive()
        • query_yes_no()
        • query_input()
    • fabsetup.utils
      • fabsetup.utils.colors
        • black()
        • red()
        • green()
        • yellow()
        • blue()
        • magenta()
        • cyan()
        • white()
        • default_color()
        • no_color()
        • color_by_name()
        • config_color()
      • fabsetup.utils.decorate
        • invoked()
      • fabsetup.utils.decorators
        • print_doc()
        • print_full_name()
      • fabsetup.utils.docstring
        • lstripped_lines()
      • fabsetup.utils.outfile
        • stream_tee
        • Singleton
        • Tee
        • remove_color_codes()
      • fabsetup.utils.pandoc
        • Pandoc
  • fabsetup.addons
    • module_username()
    • load_addon()
    • load_pip_addons()
    • load_repo_addons()
    • merge_or_add_r()
  • fabsetup.fabfile
    • versions()
    • help()
    • tasks()
    • task_help()
    • info()
    • git_name_and_email_or_die()
    • show_or_ask()
    • sanitize()
    • gather_from_user_and_task_name()
    • gather_task_infos()
    • create_files()
    • create_git_repo()
    • summary()
    • new()
  • fabsetup.main
    • Defaults
      • Defaults.as_dict()
      • Defaults.as_restructuredtext_items()
    • FabsetupConfig
      • FabsetupConfig.prefix
      • FabsetupConfig.as_dict()
      • FabsetupConfig.global_defaults()
    • Fabsetup
      • Fabsetup.core_args()
      • Fabsetup.parse_core()
      • Fabsetup.parse_cleanup()
      • Fabsetup.load_invoke_tasks()
      • Fabsetup.load_fabric_tasks()
      • Fabsetup.parse_tasks()
      • Fabsetup.update_config()
      • Fabsetup.control_output()
      • Fabsetup.control_outfile()
      • Fabsetup.execute()
      • Fabsetup.run()
      • Fabsetup.print_version()
      • Fabsetup.task_list_opener()
      • Fabsetup.print_help()
  • fabsetup.print
    • print_default()
    • print_heading()
    • print_docstring()
    • print_code_block()
    • print_command_line()
  • fabsetup.task
    • issue_16_workaround()
    • issue_833_workaround()
    • from_config()
    • increment_numbered_state()
    • append_numbered_index()
    • remove_numbered_index()
    • get_task_depth()
    • wrapped_run_method()
    • task()
    • subtask()
• API Usage
  • Invoke Example
  • Fabric Example

• Development
  • Setup
  • Tests
  • Mutation Tests
  • Run fabsetup
  • Documentation