.. -*- restructuredtext -*-

========================
README for mysql-autodoc
========================

``mysql-autodoc`` is a program to generate html documentation for 
a mysql dtabase.

The idea ant the template is base on the ``postgresql_autodo`` from  
Rod Taylor <autodoc@rbt.ca>.  

Installing
==========

Use ``setup.py``::

   python setup.py build
   sudo python setup.py install

or use ``pip``::

   pip install mysql-autodoc

Command line
============

::
    $ ./mysql-autodoc --help
    Usage: mysql-autodoc [options] database
    
    Options:
      --version             show program's version number and exit
      -h, --help            show this help message and exit
      -f FILE, --file=FILE  write documentation to FILE, default database.html
      -H HOST, --host=HOST  Database server hostname
      -u USER, --user=USER  database username
      -p                    ask for a database password
      --password=PASSWORD   database password
      -P PORT, --port=PORT  database connection port


