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
• List Interface
  • Usage
  • Overridden methods
  • Custom methods
  • Plugin format

Core documentation

Describe FlexGet framework.

• flexget Package
  • flexget Package
    • main()
  • api Module
  • config_schema Module
    • ConfigError
      • ConfigError.errors
    • ConfigValidationError
      • ConfigValidationError.json_pointer
    • get_schema()
    • is_episode_identifier()
    • is_episode_or_season_id()
    • is_file()
    • is_interval()
    • is_json()
    • is_path()
    • is_percent()
    • is_quality()
    • is_quality_req()
    • is_regex()
    • is_size()
    • is_time()
    • is_url()
    • is_valid_template()
    • one_or_more()
    • parse_interval()
    • parse_percent()
    • parse_size()
    • parse_time()
    • process_config()
    • register_config_key()
    • register_schema()
    • resolve_ref()
    • retrieve_resource()
    • select_child_errors()
    • set_error_message()
    • validate_anyOf()
    • validate_deprecated()
    • validate_oneOf()
    • validate_properties_w_defaults()
  • db_schema Module
    • FlexgetVersion
      • FlexgetVersion.created
      • FlexgetVersion.version
    • PluginSchema
      • PluginSchema.id
      • PluginSchema.plugin
      • PluginSchema.version
    • UpgradeImpossible
    • VersionedBaseMeta
      • VersionedBaseMeta.register_table()
    • after_table_create()
    • get_flexget_db_version()
    • register_plugin_table()
    • set_flexget_db_version()
    • upgrade()
    • versioned_base()
  • entry Module
    • Entry
      • Entry.accept()
      • Entry.accepted
      • Entry.add_hook()
      • Entry.add_lazy_fields()
      • Entry.complete()
      • Entry.deserialize()
      • Entry.fail()
      • Entry.failed
      • Entry.isvalid()
      • Entry.on_accept()
      • Entry.on_complete()
      • Entry.on_fail()
      • Entry.on_reject()
      • Entry.register_lazy_func()
      • Entry.reject()
      • Entry.rejected
      • Entry.render()
      • Entry.run_hooks()
      • Entry.safe_str()
      • Entry.serialize()
      • Entry.state
      • Entry.trace()
      • Entry.undecided
      • Entry.update_using_map()
    • EntryState
      • EntryState.ACCEPTED
      • EntryState.FAILED
      • EntryState.REJECTED
      • EntryState.UNDECIDED
      • EntryState.color
      • EntryState.log_markup
    • EntryUnicodeError
    • LazyFunc
      • LazyFunc.function
    • register_lazy_lookup
  • event Module
    • Event
    • add_event_handler()
    • event()
    • fire_event()
    • get_events()
    • remove_event_handler()
    • remove_event_handlers()
  • ipc Module
    • ClientService
      • ClientService.exposed_console()
      • ClientService.exposed_log_sink()
      • ClientService.exposed_version()
      • ClientService.on_connect()
    • DaemonService
      • DaemonService.client_log_sink()
      • DaemonService.client_out_stream
      • DaemonService.exposed_handle_cli()
      • DaemonService.exposed_version()
      • DaemonService.manager
      • DaemonService.on_connect()
    • IPCClient
      • IPCClient.close()
    • IPCServer
      • IPCServer.authenticator()
      • IPCServer.run()
      • IPCServer.shutdown()
      • IPCServer.start()
    • RemoteStream
      • RemoteStream.flush()
      • RemoteStream.write()
  • logger Module
  • manager Module
    • Manager
      • Manager.acquire_lock()
      • Manager.backup_config()
      • Manager.check_ipc_info()
      • Manager.check_lock()
      • Manager.config_changed()
      • Manager.crash_report()
      • Manager.daemon_command()
      • Manager.daemonize()
      • Manager.db_cleanup()
      • Manager.execute()
      • Manager.execute_command()
      • Manager.handle_cli()
      • Manager.has_lock
      • Manager.hash_config()
      • Manager.init_sqlalchemy()
      • Manager.initialize()
      • Manager.load_config()
      • Manager.matching_tasks()
      • Manager.options
      • Manager.parse_initial_options()
      • Manager.release_lock()
      • Manager.save_config()
      • Manager.setup_yaml()
      • Manager.shutdown()
      • Manager.start()
      • Manager.tasks
      • Manager.unit_test
      • Manager.update_config()
      • Manager.validate_config()
      • Manager.write_lock()
  • options Module
    • ArgumentParser
      • ArgumentParser.add_argument()
      • ArgumentParser.add_subparser()
      • ArgumentParser.add_subparsers()
      • ArgumentParser.do_help
      • ArgumentParser.error()
      • ArgumentParser.file
      • ArgumentParser.get_subparser()
      • ArgumentParser.parse_args()
      • ArgumentParser.parse_known_args()
      • ArgumentParser.set_post_defaults()
    • CoreArgumentParser
      • CoreArgumentParser.add_subparsers()
      • CoreArgumentParser.parse_args()
    • CronAction
    • DebugAction
    • DebugTraceAction
    • HelpAction
    • InjectAction
    • NestedSubparserAction
      • NestedSubparserAction.add_parser()
    • ParseExtrasAction
    • ParserError
    • ScopedNamespace
    • VersionAction
    • get_parser()
    • register_command()
    • required_length()
  • plugin Module
    • DependencyError
      • DependencyError.has_message()
      • DependencyError.message
    • PluginError
    • PluginInfo
      • PluginInfo.build_phase_handlers()
      • PluginInfo.dupe_counter
      • PluginInfo.initialize()
    • PluginWarning
    • RegisterException
    • get()
    • get_phases_by_plugin()
    • get_plugin_by_name()
    • get_plugins()
    • internet
    • load_plugins()
    • plugin_schemas()
    • priority()
    • register
    • register_schema()
    • register_task_phase()
  • task Module
    • EntryContainer
      • EntryContainer.accepted
      • EntryContainer.entries
      • EntryContainer.failed
      • EntryContainer.rejected
      • EntryContainer.undecided
    • EntryIterator
      • EntryIterator.reverse()
      • EntryIterator.sort()
    • Task
      • Task.RERUN_DEFAULT
      • Task.RERUN_MAX
      • Task.abort()
      • Task.accepted
      • Task.all_entries
      • Task.check_config_hash()
      • Task.config_changed()
      • Task.copy()
      • Task.disable_phase()
      • Task.disable_plugin()
      • Task.entries
      • Task.execute()
      • Task.failed
      • Task.find_entry()
      • Task.is_rerun
      • Task.lock_reruns()
      • Task.max_reruns
      • Task.merge_config()
      • Task.plugins()
      • Task.rejected
      • Task.render()
      • Task.rerun()
      • Task.rerun_count
      • Task.reruns_locked
      • Task.undecided
      • Task.unlock_reruns()
      • Task.validate_config()
    • TaskAbort
    • TaskConfigHash
      • TaskConfigHash.hash
      • TaskConfigHash.id
      • TaskConfigHash.task
    • register_config_key()
    • use_task_logging()
  • task_queue Module
    • TaskQueue
      • TaskQueue.is_alive()
      • TaskQueue.put()
      • TaskQueue.run()
      • TaskQueue.shutdown()
      • TaskQueue.start()
      • TaskQueue.wait()
  • webserver Module
    • User
      • User.get_id()
      • User.id
      • User.name
      • User.password
      • User.token
    • WeakPassword
    • WebSecret
      • WebSecret.id
      • WebSecret.value
    • WebServer
      • WebServer.run()
      • WebServer.start()
      • WebServer.stop()
      • WebServer.triggers_lock
    • generate_key()
    • get_random_string()
    • register_app()
    • register_home()
    • setup_server()
    • start_page()
  • 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