Skip to main content

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

Metadata

Release files for mysql-autodoc 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mysql-autodoc 0.2
File Size Uploaded Provenance
mysql-autodoc-0.2.tar.gz 5.4 kB Without provenance Details

Release files / mysql-autodoc-0.2.tar.gz

Download URL mysql-autodoc-0.2.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6c696872622509e4aeafa8939322dc061f389fee72e0c9923a6327aefbd35b93
BLAKE2b-256 checksum
How to use checksums
ac02befb35ca05474b17dfe31996283cbcf13fde227babaac29da6d7f687b293
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for mysql-autodoc 0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page