Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.02 KB

cli.rst

File metadata and controls

66 lines (43 loc) · 2.02 KB
Raw

Command line interface

(Status: Partially implemented)

The oh-bugimporters package has the capability to crawl remote bug trackers and store the parsed data in YAML files. To use this functionality, you must create a YAML file with information about the remote bug trackers you want to crawl.

This document steps you through that.

In order to do a bug crawl, you'll need to follow these steps:

Configure some Tracker Model data

Create a YAML file in, for example, /tmp/configuration.yaml, that is a list of dictionaries.

The dictionaries must have the following keys:

  • tracker_name (string)
  • base_url (string)

The following key is optional, and if present, is used when annotating the the bug data with the project name. By default, this is the same as the tracker_name.

  • bug_project_name_format (string)

The following keys are optional, and are used during bug data processing to annotate the bug data with information like if the bug is good for first-time contributors, or if the bug is oriented entirely around documentation.

  • bitesized_type (string)
  • bitesized_text (string)
  • documentation_type (string)
  • documentation_text (string)

A sample valid yaml file can be found in examples/sample_configuration.yaml.

Run the command line interface

Run this command:

./env/bin/python bugimporters/main.py -i /tmp/configuration.yaml -o /tmp/output.yaml

This will read the configuration YAML file you have named, and go off and download bugs. When it exits, /tmp/output.yaml will have the parsed bug data.

Flaws

Flaws at the moment:

  • Right now, the command line interface assumes that the bug tracker is of type Trac. We should update the input format correspondingly.
  • We need to modify the YAML input format to support listing query URLs. Otherwise, you end up with the silly hack stuff that you see in main.py around get_query_url.
  • We need to modify the output format to support requesting deletion of data for a bug.
  • And yeah, test coverage.