DevelopingProcess

Differences between revisions 1 and 11 (spanning 10 versions)
Revision 1 as of 2007-03-19 11:34:39
Size: 259
Editor: a89-182-0-177
Comment:
Revision 11 as of 2007-05-30 09:20:06
Size: 4756
Editor: a89-182-30-65
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
==Options== == Options ==
Line 5: Line 5:
===bughelper=== === bughelper ===
Line 7: Line 7:
||Option||Description||Comments||Status||
||--sort||Option to sort output||Easy to provide, bugnumbers already has this option (MarkusKorn)||||
||'''Option'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||--sort||Option to sort output||Easy to provide, bugnumbers already has this option (MarkusKorn)||-||||
||-b||only search in given bug(s)||we should expand that option in a way that the argument can also be a list of bugs (MarkusKorn)|| || ||
||(--Aonly)||only searching attachments which matches a given RegEx||general parts of the necessary code are already available in the BugAttachment-class (MarkusKorn)||[https://bugs.launchpad.net/bughelper/+bug/88521 #88521]|| ||
||(--close)||option to look for a clue through open and closed bugs on the package specified|| ||[https://bugs.launchpad.net/bughelper/+bug/81434 #81434]|| (./) ||

=== bugnumbers ===

||'''Option'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||--sort||Documentation||The sort option with all its options needs to be documented (MarkusKorn)||-||||
||--lc||last comment by user||Needs to be reviewed to get it into main (MarkusKorn)||[https://launchpad.net/bughelper/+bug/79136 #79136]|| (./) ||
||--count||change function to count comments from BugPage() to Bug()||Needs to be reviewed to get it into main (MarkusKorn)||[https://launchpad.net/bughelper/+bug/93658 #93658]|| (./) ||
||(--duplicates)||get the number of duplicates of a bug|| ||[https://bugs.launchpad.net/bughelper/+bug/79140 #79140]|| (./) ||

=== buginfo ===

=== bugxml ===

== General Features ==

=== Attachment-Cache ===

||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||<rowspan=2> cleaning cache||1.) changing the path to file|| ||[https://launchpad.net/bughelper/+bug/87448 #87448]|| (./) ||
||2.) removing unused attachments||If the path to a attachment is in the old style after using bughelper for a bit, the old-unused attachment can be removed (MarkusKorn)||-|| (./) ||

=== User interface ===

||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||simple Web Interface||Web interface provided by Web.py||I tried to built a simple Web-UI. Result: If we want to run bughelper as a server application Web.py is not the right solution. My attempt is still in my branch ~bughelper.r01 (MarkusKorn)||[https://bugs.launchpad.net/bughelper/+bug/81291 #81291]||||

=== bughelper ===

||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||store output in data-structure||The output can be sorted by the clue-info|| ||[https://bugs.launchpad.net/bughelper/+bug/88102 #88102]||||
||log its searches||log or bookmark feature|| ||[https://bugs.launchpad.net/bughelper/+bug/81288 #81288]|| ||

=== Clue-Files ===

||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||Completely support tags||use LP-tags in cluefiles|| ||[https://bugs.launchpad.net/bughelper/+bug/88719 #88719]|| (./) ||
||grep for package version||adding something like "fixed since" to clue-files|| ||[https://bugs.launchpad.net/bughelper/+bug/84723 #84723]||||

=== Server Application ===

||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
||Framework|| ||My favorite is [http://pylonshq.com/ pylons] (MarkusKorn)|| ||||
||Result caching|| || || || ||

=== PlugIn for Email-Client and IRC-Client ===

== General Improvements ==

=== python-launchpad-bugs ===

 * change the API, further descriptions in python-launchpad-bugs/API_changes
 * add delete_attachment method to the Bug-class

=== Output ===

The output of bugnumbers and buginfo has to be generated in an external class, this was we can easily add --format options like in bughelper (MarkusKorn) (./)
=== RegEx/XPath ===

We should use XPath instead of RegEx to parse the LP-Pages.The patch provided in [https://launchpad.net/bughelper/+bug/93499 Bug 93499] ([http://librarian.launchpad.net/6852479/xpath_v1.patch xpath_v1.patch]) is a first attempt (MarkusKorn) (./)

=== Code Cleanup ===

 * changing the type of buglists like all_bugs from set() to list() would make it possible to use the filter()-function. apport uses the set()-type buglist! (MarkusKorn)
 * Bug().info is currently a string, we should change it into list() to get more output-formar options and to get the possibility to sort the output (MarkusKorn)
 * Code needs to be documented (MarkusKorn)

== Documentation ==

The last update of the documentation (wiki/man-pages) was before release 0.1. As the tools are getting more and more complex with even more command-line options we maybe need a (alphabetically) order of the options in the help screen.(MarkusKorn)

This page tries to give an overview of the developing process of bughelper.

Options

bughelper

Option

Description

Comments

LP-Bug

Status

--sort

Option to sort output

Easy to provide, bugnumbers already has this option (MarkusKorn)

-

-b

only search in given bug(s)

we should expand that option in a way that the argument can also be a list of bugs (MarkusKorn)

(--Aonly)

only searching attachments which matches a given RegEx

general parts of the necessary code are already available in the BugAttachment-class (MarkusKorn)

[https://bugs.launchpad.net/bughelper/+bug/88521 #88521]

(--close)

option to look for a clue through open and closed bugs on the package specified

[https://bugs.launchpad.net/bughelper/+bug/81434 #81434]

(./)

bugnumbers

Option

Description

Comments

LP-Bug

Status

--sort

Documentation

The sort option with all its options needs to be documented (MarkusKorn)

-

--lc

last comment by user

Needs to be reviewed to get it into main (MarkusKorn)

[https://launchpad.net/bughelper/+bug/79136 #79136]

(./)

--count

change function to count comments from BugPage() to Bug()

Needs to be reviewed to get it into main (MarkusKorn)

[https://launchpad.net/bughelper/+bug/93658 #93658]

(./)

(--duplicates)

get the number of duplicates of a bug

[https://bugs.launchpad.net/bughelper/+bug/79140 #79140]

(./)

buginfo

bugxml

General Features

Attachment-Cache

Feature

Description

Comments

LP-Bug

Status

cleaning cache

1.) changing the path to file

[https://launchpad.net/bughelper/+bug/87448 #87448]

(./)

2.) removing unused attachments

If the path to a attachment is in the old style after using bughelper for a bit, the old-unused attachment can be removed (MarkusKorn)

-

(./)

User interface

Feature

Description

Comments

LP-Bug

Status

simple Web Interface

Web interface provided by Web.py

I tried to built a simple Web-UI. Result: If we want to run bughelper as a server application Web.py is not the right solution. My attempt is still in my branch ~bughelper.r01 (MarkusKorn)

[https://bugs.launchpad.net/bughelper/+bug/81291 #81291]

bughelper

Feature

Description

Comments

LP-Bug

Status

store output in data-structure

The output can be sorted by the clue-info

[https://bugs.launchpad.net/bughelper/+bug/88102 #88102]

log its searches

log or bookmark feature

[https://bugs.launchpad.net/bughelper/+bug/81288 #81288]

Clue-Files

Feature

Description

Comments

LP-Bug

Status

Completely support tags

use LP-tags in cluefiles

[https://bugs.launchpad.net/bughelper/+bug/88719 #88719]

(./)

grep for package version

adding something like "fixed since" to clue-files

[https://bugs.launchpad.net/bughelper/+bug/84723 #84723]

Server Application

Feature

Description

Comments

LP-Bug

Status

Framework

My favorite is [http://pylonshq.com/ pylons] (MarkusKorn)

Result caching

PlugIn for Email-Client and IRC-Client

General Improvements

python-launchpad-bugs

  • change the API, further descriptions in python-launchpad-bugs/API_changes
  • add delete_attachment method to the Bug-class

Output

The output of bugnumbers and buginfo has to be generated in an external class, this was we can easily add --format options like in bughelper (MarkusKorn) (./)

RegEx/XPath

We should use XPath instead of RegEx to parse the LP-Pages.The patch provided in [https://launchpad.net/bughelper/+bug/93499 Bug 93499] ([http://librarian.launchpad.net/6852479/xpath_v1.patch xpath_v1.patch]) is a first attempt (MarkusKorn) (./)

Code Cleanup

  • changing the type of buglists like all_bugs from set() to list() would make it possible to use the filter()-function. apport uses the set()-type buglist! (MarkusKorn)

  • Bug().info is currently a string, we should change it into list() to get more output-formar options and to get the possibility to sort the output (MarkusKorn)

  • Code needs to be documented (MarkusKorn)

Documentation

The last update of the documentation (wiki/man-pages) was before release 0.1. As the tools are getting more and more complex with even more command-line options we maybe need a (alphabetically) order of the options in the help screen.(MarkusKorn)

BugHelper/Dev/DevelopingProcess (last edited 2008-08-06 16:14:59 by localhost)