FlexGet’s documentation!

This documentation contains developer guide, technical core documentation and relevant plugin documentation that is relevant to the developers wishing to extend FlexGet.

Indices and tables

• Index
• Module Index
• Search Page

Instructions for aspiring developer

• Introduction
  • Technologies used
  • How do I get started?
  • Environment
  • Code quality
• Mock data
  • Mock input
  • Inject
  • Commandline values
• TDD in practice
  • Create test
  • Create plugin
  • Add test
  • Add functionality to plugin
  • Summary
• Database
  • Migrations
  • Database cleanups
• Plugin Schemas
  • Keywords

Core documentation

Describe FlexGet framework.

• flexget Package
  • flexget Package
  • api Module
  • config_schema Module
  • db_schema Module
  • entry Module
  • event Module
  • ipc Module
  • logger Module
  • manager Module
  • options Module
  • plugin Module
  • task Module
  • task_queue Module
  • webserver Module
  • validator Module
  • Subpackages
    • utils Package
      • bittorrent Module
      • cached_input Module
      • database Module
      • imdb Module
      • log Module
      • qualities Module
      • requests Module
      • search Module
      • simple_persistence Module
      • soup Module
      • sqlalchemy_utils Module
      • template Module
      • tools Module
      • Subpackages

Plugins

This list is not up-to-date and should probably only contain plugins that serve API to other plugins.

• plugins Package
  • plugins Package
  • api_tmdb Module
  • api_tvdb Module
  • plugin_change_warn Module
  • plugin_cookies Module
  • plugin_deluge Module
  • plugin_entry_trace Module
  • plugin_formlogin Module
  • plugin_import_series Module
  • plugin_include Module
  • plugin_preset Module
  • plugin_sort_by Module
  • plugin_spy_headers Module
  • plugin_transmission Module
  • plugin_try_regexp Module
  • plugin_urlrewriting Module
  • plugin_verbose Module
  • plugin_verbose_details Module
  • search_kat Module
  • search_rss Module
  • urlrewrite_bakabt Module
  • urlrewrite_btchat Module
  • urlrewrite_btjunkie Module
  • urlrewrite_deadfrog Module
  • urlrewrite_extratorrent Module
  • urlrewrite_google_cse Module
  • urlrewrite_isohunt Module
  • urlrewrite_newtorrents Module
  • urlrewrite_newzleech Module
  • urlrewrite_nyaa Module
  • urlrewrite_piratebay Module
  • urlrewrite_redskunk Module
  • urlrewrite_search Module
  • urlrewrite_stmusic Module
  • urlrewrite_torrentz Module
  • urlrewrite_urlrewrite Module
  • Subpackages