Library documentation

Modules, classes, functions and constants are documented here.

• evariste.builder
  • Builder
    • Builder.shared
    • Builder.cache
    • Builder.plugins
    • Builder.close()
    • Builder.compile()
    • Builder.from_setupdict()
    • Builder.from_setupname()
• evariste.hooks
  • Example
  • Get functions registered as hooks
  • Method hooks
    • setmethodhook()
  • Context hooks
  • Iteration hooks
  • Register functions as hooks
    • hook()
    • contexthook()
    • methodhook()
    • iterhook()
• evariste.plugins
  • Constants
    • MANDATORY_PLUGINS
  • Plugin
    • Plugin
      • Plugin.default_setup
      • Plugin.depends
      • Plugin.depends_dynamic()
      • Plugin.global_default_setup
      • Plugin.keyword
      • Plugin.local
      • Plugin.match()
      • Plugin.plugin_type
      • Plugin.priority
      • Plugin.shared
  • Loader
    • Loader
      • Loader.applyiterhook()
      • Loader.get_plugin()
      • Loader.items()
      • Loader.iter()
      • Loader.match()
      • Loader.values()
  • Functions
    • find_plugins()
  • Exceptions
    • NoMatch
  • evariste.plugins.action
    • Action
      • Action
        • Action.compile()
        • Action.lock
        • Action.match()
        • Action.plugin_type
    • Report
      • Report
        • Report.full_depends
        • Report.success
  • evariste.plugins.renderer
    • evariste.plugins.renderer.jinja2
      • Jinja2Renderer
        • Jinja2Renderer.default_setup
        • Jinja2Renderer.get_readme()
        • Jinja2Renderer.iter_subplugins()
        • Jinja2Renderer.render()
        • Jinja2Renderer.render_tree()
        • Jinja2Renderer.template
      • evariste.plugins.renderer.jinja2.file
        • Jinja2FileRenderer
          • Jinja2FileRenderer.extension
          • Jinja2FileRenderer.keyword
          • Jinja2FileRenderer.match()
          • Jinja2FileRenderer.priority
          • Jinja2FileRenderer.render()
          • Jinja2FileRenderer.template
      • evariste.plugins.renderer.jinja2.readme
        • Jinja2ReadmeRenderer
          • Jinja2ReadmeRenderer.extensions
          • Jinja2ReadmeRenderer.get_readme()
          • Jinja2ReadmeRenderer.match()
          • Jinja2ReadmeRenderer.render()
    • evariste.plugins.renderer.html
      • HTMLRenderer
        • HTMLRenderer.default_setup
        • HTMLRenderer.depends
        • HTMLRenderer.keyword
        • HTMLRenderer.template
      • evariste.plugins.renderer.html.file
        • HtmlFileRenderer
          • HtmlFileRenderer.extension
          • HtmlFileRenderer.keyword
          • HtmlFileRenderer.plugin_type
      • evariste.plugins.renderer.html.readme
        • HtmlReadmeRenderer
          • HtmlReadmeRenderer.extensions
          • HtmlReadmeRenderer.keyword
          • HtmlReadmeRenderer.plugin_type
  • evariste.plugins.vcs
    • evariste.plugins.vcs
      • VCS
        • VCS.__contains__()
        • VCS.from_repo()
        • VCS.global_default_setup
        • VCS.last_modified()
        • VCS.plugin_type
        • VCS.source
        • VCS.walk()
        • VCS.workdir
    • evariste.plugins.none
      • NoneVCS
        • NoneVCS.__contains__()
        • NoneVCS.keyword
        • NoneVCS.walk()
        • NoneVCS.workdir
    • evariste.plugins.git
      • Git
        • Git.__contains__()
        • Git.keyword
        • Git.last_modified()
        • Git.walk()
        • Git.workdir
• evariste.shared
  • Shared
    • Shared.get_plugin_view()
    • Shared.get_tree_view()
• evariste.tree
  • Tree
    • Tree
      • Tree.basename
      • Tree.config
      • Tree.count()
      • Tree.depth
      • Tree.find()
      • Tree.format()
      • Tree.from_fs
      • Tree.from_source
      • Tree.full_depends()
      • Tree.is_dir()
      • Tree.is_file()
      • Tree.is_root()
      • Tree.local
      • Tree.parent
      • Tree.prune()
      • Tree.relativename
      • Tree.report
      • Tree.root
      • Tree.shared
      • Tree.vcs
      • Tree.walk()
  • File
    • File
      • File.compile()
      • File.depends()
      • File.full_depends()
      • File.last_modified()
      • File.make_archive()
  • Directory
    • Directory
      • Directory.__contains__()
      • Directory.__delitem__()
      • Directory.__getitem__()
      • Directory.__iter__()
      • Directory.add_subpath()
      • Directory.compile()
      • Directory.full_depends()
      • Directory.keys()
      • Directory.values()
      • Directory.walk()
  • Root
    • Root
      • Root.from_vcs()
      • Root.is_root()
      • Root.root_compile()
      • Root.set_config()
• evariste.utils
  • DeepDict
    • DeepDict.copy()
    • DeepDict.fill_blanks()
    • DeepDict.from_configparser()
    • DeepDict.get_subkey()
  • smart_open()
  • yesno()
  • expand_path()
  • ChangeDir
  • cached_iterator()