Diff for "BugHelper/Dev/DevelopingProcess"

DevelopingProcess

Differences between revisions 4 and 15 (spanning 11 versions)

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)	#88521
(--close)	option to look for a clue through open and closed bugs on the package specified		#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)	#79136
--count	change function to count comments from BugPage() to Bug()	Needs to be reviewed to get it into main (MarkusKorn)	#93658
(--duplicates)	get the number of duplicates of a bug		#79140

buginfo

bugxml

General Features

Attachment-Cache

Feature	Description	Comments	LP-Bug	Status
cleaning cache	1.) changing the path to file		#87448
cleaning cache	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)	#81291

bughelper

Feature	Description	Comments	LP-Bug	Status
store output in data-structure	The output can be sorted by the clue-info		#88102
log its searches	log or bookmark feature		#81288

Clue-Files

Feature	Description	Comments	LP-Bug	Status
Completely support tags	use LP-tags in cluefiles		#88719
grep for package version	adding something like "fixed since" to clue-files		#84723

Server Application

Feature	Description	Comments	LP-Bug	Status
Framework		My favorite is 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)
use staticmethod() in format-modules (MarkusKorn)

RegEx/XPath

We should use XPath instead of RegEx to parse the LP-Pages.The patch provided in Bug 93499 (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)
use file() instead of open() to write/read local files (open() is "deprecated") (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)

Go Back to BugHelper/Dev.
CategoryBugHelper

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

-  ⇤ ← Revision 4 as of 2007-03-19 12:14:06 → 
  Size: 1537
  Editor: a89-182-0-177
  Comment:
+   ← Revision 15 as of 2008-08-06 16:14:59 → ⇥
  Size: 5062
  Editor: localhost
  Comment: converted to 1.6 markup
-Deletions are marked like this.
+Additions are marked like this.
 Line 7:
-||'''Option'''||'''Description'''||'''Comments'''||'''LP-Bug Nr'''||'''Status'''||
+||'''Option'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
 Line 9:
-||--bugnr||only search in given bug(s)|| || || ||
+||-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]]|| (./) ||
-Line 13:
+Line 15:
-||'''Option'''||'''Description'''||'''Comments'''||'''LP-Bug Nr'''||'''Status'''||
+||'''Option'''||'''Description'''||'''Comments'''||'''LP-Bug'''||'''Status'''||
-Line 16:
+Line 17:
+||--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]]|| (./) ||
-Line 25:
+Line 29:
-||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug Nr'''||'''Status'''||
||<rowspan=2> cleaning cache||1.) changing the path to file|| ||[https://launchpad.net/bughelper/+bug/87448 #87448]||Fix Committed||
||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)||-||||
+||'''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)||-|| (./) ||
-Line 31:
+Line 35:
-||'''Feature'''||'''Description'''||'''Comments'''||'''LP-Bug Nr'''||'''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]||||
+||'''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|| || || || ||
-Line 35:
+Line 57:
+== General Improvements ==

=== python-launchpad-bugs ===

 * change the API, further descriptions in [[BugHelper/Dev/python-launchpad-bugs/API_changes| 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)  (./)
 * use staticmethod() in format-modules (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)
 * use file() instead of open() to write/read local files (open() is "deprecated") (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)

----
Go Back to '''[[BugHelper/Dev]]'''.<<BR>>
CategoryBugHelper

Ubuntu Wiki

DevelopingProcess

Options

bughelper

bugnumbers

buginfo

bugxml

General Features

Attachment-Cache

User interface

bughelper

Clue-Files

Server Application

PlugIn for Email-Client and IRC-Client

General Improvements

python-launchpad-bugs

Output

RegEx/XPath

Code Cleanup

Documentation