Metadata-Version: 1.0
Name: mysql-autodoc
Version: 0.2
Summary: Generate HTML documentation from a mysql database
Home-page: http://www.pegueroles.com/
Author: Ferran Pegueroles Forcadell
Author-email: ferran@pegueroles.com
License: GPL
Download-URL: https://bitbucket.org/ferranp/mysql-autodoc/downloads
Description: .. -*- 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>.
        
        Version 0.2
        ===========
        
        It doesnt't depend any more on a C API and on external dll for MySQL Connector (which was the case with MySQL-python).
        It now depends on a MySQL driver written in Python et available on Python Package Index: mysql-connector-python (>=1.0).
        Dependance on Jinja2 (>2.4) still.
        
        Auto-install dependances.
        
        Tested on Python 2.6, 2.7 and 3.3.
        
        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
              -v                    verbose mode
        
        
        
        
        
Platform: linux
Platform: windows
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python
Classifier: Topic :: Database
Classifier: Topic :: Utilities
Classifier: Topic :: Documentation
