Description
-----------

Bicho is a command line based tool used to parse bug/issue tracking systems. It
gets all the information associated to issues and store them in a relation
database.


 License
---------

Bicho is licensed under GNU General Public License (GPL), version 2 or later.


 How to get Bicho
----------------

Releases:
  * http://projects.libresoft.es/projects/bicho/files

Latest version:
  * git clone http://git.libresoft.es/bicho
  * git clone git://git.libresoft.es/git/bicho


 Requirements
------------

 * Python >= 2.4
 * Python Storm. Depending on the database driver to be used you'll also need
 one of the following python libraries:
   - mysqldb or psycopg2 or pysqlite2
 * Beautiful Soup library: error-tolerant HTML parser for Python


 Installing bicho
----------------

 You can install bicho running the setup.py script:

  # python setup.py install

 For the impatients:

  $ bicho --help


 Contact
-------

 * Website

   http://projects.libresoft.es/projects/bicho

 * Mailing list

   http://lists.morfeo-project.org/pipermail/libresoft-tools-devel/

 * IRC

   #libresoft at freenode.net


 Examples
--------

It is very important to use a delay, if you run Bicho against big sites with a
delay between bug petitions your IP address could be banned!

E1. Getting information from a project that uses Bugzilla, like Bicho ;)

$ bicho --db-user-out=[DB USER] --db-password-out=[DB PASS] --db-database-out=[DB NAME] bg https://bugzilla.libresoft.es/buglist.cgi?product=bicho

E2. Getting information from a project hosted in sourceforge.net

$ bicho --db-user-out=[DB USER] --db-password-out=[DB PASS] --db-database-out=[DB NAME] -d 15 sf "http://sourceforge.net/tracker/?atid=516295&group_id=66938"

E3. Getting information from a project using JIRA

$ bicho --db-user-out=[DB USER] --db-password-out=[DB PASS] --db-database-out=[DB NAME] -d 15 jira http://support.petalslink.com/browse/PETALSMASTER


 FAQ
----

F1. Bicho crashed with 'UnicodeEncodeError' exception

UnicodeEncodeError appears when it is not possible to write the data in the
database with the encoding used by this one, to avoid that set your database to
use UTF-8

F2. What is the database schema?

There is a nice PNG schema in the directory /doc/database

F3. How can I create a new backend?

Tell us through the contact information above that you want to create a new
backend, we'll try to give you as much information as possible.