Table of Contents

Home

• Introduction

User Documentation

• Installation
  • Prerequisites
  • Gentoo
  • Manual installation
• Getting Started
  • Basic usage
• Configuration
  • Files
  • Custom flags
  • Custom aliases
• Release Notes
  • 0.91.1
  • 0.91.0
  • 0.90.0
  • 0.7.0
  • 0.6.1
  • 0.6.0
  • 0.5.0
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.1
  • 0.1.0

Developer Documentation

• Contributing
  • Workflow
  • Code style
• API Reference
  • find_work.cache
    • write_raw_json_cache()
    • read_raw_json_cache()
  • find_work.cli
    • find_work.cli.config
      • CustomFlag
        • CustomFlag.handle_parse_result()
      • ClickCustomFlagsGroup
        • ClickCustomFlagsGroup.get_params()
      • ClickExecutorGroup
        • ClickExecutorGroup.list_commands()
        • ClickExecutorGroup.get_command()
        • ClickExecutorGroup.format_commands()
        • ClickExecutorGroup.add_command()
        • ClickExecutorGroup.command()
        • ClickExecutorGroup.group()
    • find_work.cli.messages
      • Message
        • Message.text
        • Message.color
      • Status
        • Status.CACHE_READ
        • Status.CACHE_LOAD
        • Status.CACHE_WRITE
      • Result
        • Result.EMPTY_RESPONSE
        • Result.NO_WORK
    • find_work.cli.options
      • OptionsBase
        • OptionsBase.model_config
        • OptionsBase.children
        • OptionsBase.attr_order
        • OptionsBase.model_computed_fields
        • OptionsBase.model_fields
      • MainOptions
        • MainOptions.colors
        • MainOptions.verbose
        • MainOptions.breadcrumbs
        • MainOptions.maintainer
        • MainOptions.only_installed
        • MainOptions.override()
        • MainOptions.echo()
        • MainOptions.vecho()
        • MainOptions.secho()
        • MainOptions.exit()
        • MainOptions.attr_order
        • MainOptions.model_computed_fields
        • MainOptions.model_config
        • MainOptions.model_fields
    • find_work.cli.plugins
      • PluginSpec
        • PluginSpec.attach_base_command()
        • PluginSpec.setup_base_command()
        • PluginSpec.get_command_by_name()
    • find_work.cli.widgets
      • ProgressDots
        • ProgressDots.interval
        • ProgressDots.indicator
    • colors_disabled_by_env()
  • find_work.constants
    • PACKAGE
    • VERSION
    • HOMEPAGE
    • ENTITY
    • USER_AGENT
    • DEFAULT_CONFIG
  • find_work.types
    • find_work.types.breadcrumbs
      • is_feedable()
      • encode_value()
      • Breadcrumbs
        • Breadcrumbs.hexdigest()
        • Breadcrumbs.feed()
        • Breadcrumbs.feed_option()
        • Breadcrumbs.model_computed_fields
        • Breadcrumbs.model_config
        • Breadcrumbs.model_fields
        • Breadcrumbs.model_post_init()
    • VersionPart
      • VersionPart.MAJOR
      • VersionPart.MINOR
      • VersionPart.PATCH
    • VersionBump
      • VersionBump.atom
      • VersionBump.old_version
      • VersionBump.new_version
      • VersionBump.changed()
    • BugView
      • BugView.bug_id
      • BugView.last_change_date
      • BugView.assigned_to
      • BugView.summary
  • find_work.utils
    • extract_package_name()
    • aiohttp_session()
    • requests_session()

External Links

• Git Repository
• PyPI Package

Indices and tables

• Search Page