dob package

Subpackages

• dob.clickux package
  • Submodules
  • dob.clickux.add_fact_help_group module
  • dob.clickux.aliasable_bunchy_plugin module
  • dob.clickux.better_format_usage module
  • dob.clickux.better_help_headers module
  • dob.clickux.bunchy_group module
  • dob.clickux.bunchy_help module
  • dob.clickux.cmd_options module
  • dob.clickux.cmd_options_search module
  • dob.clickux.help_command module
  • dob.clickux.help_detect module
  • dob.clickux.help_header module
  • dob.clickux.help_string_add_fact module
  • dob.clickux.help_strings module
  • dob.clickux.induct_newbies module
  • dob.clickux.plugin_group module
  • dob.clickux.post_processor module
  • dob.clickux.query_assist module
  • Module contents
• dob.cmds_list package
  • Submodules
  • dob.cmds_list.activity module
  • dob.cmds_list.category module
  • dob.cmds_list.fact module
  • dob.cmds_list.tag module
  • Module contents
• dob.cmds_usage package
  • Submodules
  • dob.cmds_usage.activity module
  • dob.cmds_usage.category module
  • dob.cmds_usage.tag module
  • Module contents
• dob.facts package
  • Submodules
  • dob.facts.add_fact module
  • dob.facts.cancel_fact module
  • dob.facts.echo_fact module
  • dob.facts.edit_fact module
  • dob.facts.import_facts module
  • dob.facts.save_backedup module
  • dob.facts.save_confirmed module
  • dob.facts.save_confirmer module
  • dob.facts.simple_prompts module
  • Module contents
• dob.helpers package
  • Submodules
  • dob.helpers.path module
  • Module contents

Submodules

dob.complete module

dob.complete.tab_complete(controller)

dob.config module

dob.config.echo_config_table(controller, section, keyname, output_format, table_type)

dob.config.echo_config_value(ctx, controller, parts)

dob.config.edit_config_file(controller)

dob.config.write_config_value(ctx, controller, parts)

dob.controller module

A lite wrapper around the dob-bright Controller.

class dob.controller.Controller(config=None)

Bases: nark.control.NarkControl

A custom controller that adds config handling on top of its regular functionality.

POST_PROCESSORS = []

affirm(condition)

bulk_set_log_levels(log_level)

check_sqlite_store_ready()

create_config(force)

create_config_and_store(fact_cls=<class 'nark.items.fact.Fact'>)

create_data_store(force, fact_cls=<class 'nark.items.fact.Fact'>)

data_store_exists_at

data_store_url

disable_logging()

ensure_config(ctx, configfile_path=None, *keyvals)

find_latest_fact(restrict=None)

find_oldest_fact()

get_loggers()

insist_germinated(fact_cls=<class 'nark.items.fact.Fact'>)

Assist user if config or database not present.

is_germinated

must_unlink_db_path(*_args, force)

now

now_refresh()

pdb_break_enter()

pdb_break_leave()

pdb_set_trace()

post_process(controller, fact_facts_or_true, show_plugin_error=None, carousel_active=False)

static post_processor(func)

replay_config()

round_out_config()

setup_config(configfile_path=None, *keyvals)

setup_config_from_file_and_cli(configfile_path=None, *keyvals)

setup_logging(verbose=False, verboser=False)

Setup logging for the lib_logger as well as client specific logging.

setup_tty_color(use_color)

sqlite_db_path

standup_store(fact_cls=<class 'nark.items.fact.Fact'>)

store_exists

wire_configience(config_root=None)

write_config(skip_unset=False)

dob.copyright module

Copyright output UX methods.

dob.copyright.assemble_copyright()

Display a greeting message providing basic set of information.

dob.copyright.echo_copyright()

dob.copyright.echo_license()

dob.demo module

dob-demo command

dob.demo.demo_config(func)

dob.demo.demo_dob(controller)

dob.details module

dob.details.echo_app_details(controller, full=False)

List details about the runtime environment.

dob.details.echo_app_environs(controller)

List details about runtime in source’able name=value format.

dob.details.echo_data_stats(controller)

dob.details.hamster_time(posits=[])

dob.dob module

A time tracker for the command line. Utilizing the power of hamster! [nark].

dob.dob.edit_fact_by_key(ctx, controller, *args, key, no_editor, edit_text, edit_meta, **kwargs)

dob.dob.generate_add_fact_command(time_hint)

dob.dob.query_activities(ctx, controller, *args, **kwargs)

dob.dob.query_categories(ctx, controller, *args, **kwargs)

dob.dob.query_tags(ctx, controller, *args, **kwargs)

dob.migrate module

dob.migrate.control(controller)

dob.migrate.downgrade(controller)

dob.migrate.upgrade(controller)

dob.migrate.version(controller, silent_check=False, must=True)

dob.migrate.latest_version(controller, silent_check=False, must=True)

dob.migrate.upgrade_legacy_database_file(ctx, controller, file_in, force)

dob.migrate.upgrade_legacy_database_instructions(controller)

dob.plugins module

Plugin installer plugins call… to install themselves.

dob.plugins.install_plugin(package_module_path, package_plugin_name)

Helper function for Dob plugins to use to install themselves.

For an example, see:

https://github.com/hotoffthehamster/dob-plugin-example

and search PyPI for matching “dob-plugin-*” projects.

dob.run_cli module

Defines the main Click Group.

dob.run_cli.pass_controller(f)

dob.run_cli.pass_controller_context(func)

dob.run_cli.dob_versions(include_all=False)

Return CLI version information, either for this package, or all HOTH packages.

Module contents

hamster, hamster, hamster!!! a cuddly, furry time tracker.

dob.get_version(include_head=False)