mongodoc

mongodoc is a Python module that creates a UML-like diagram for a nested mongodb document.

If you have a mongodb database that you wish to document, a good starting point might be to install mongodoc and use the doc-db command:

doc-db test

After answering a few questions, you will get an output file that will look something like this:

 _____________________________________________________________________________
| people |
|_____________________________________________________________________________|
| last: < type 'unicode' > ________________________________|
| mood: < type 'unicode' > | address ||
| age: < type 'int' > |________________________________||
| location: < type 'unicode' > | state: < type 'unicode' > ||
| address: < type 'dict' > | street: < type 'unicode' > ||
| _id: < class 'bson.objectid.ObjectId' > | number: < type 'int' > ||
| first: < type 'unicode' > | zip: < type 'int' > ||
| |________________________________||
|_____________________________________________________________________________|

This document has a sub-document for the value of the address field, so it appears as a box within the people diagram. You will get one of these diagrams for each collection in the db.

The doc-db command has a few options for connecting to the db:

% doc-db -h
usage: doc-db [-h] [--port PORT] [--host HOST] [--username USERNAME]
 [--password PASSWORD] [--file FILE]
 name

Document a mongo db

positional arguments:
 name The name of the mongo db to document

optional arguments:
 -h, --help show this help message and exit
 --port PORT The db port number
 --host HOST The db host
 --username USERNAME The username for authenticating to the db
 --password PASSWORD The password for authenticating to the db
 --file FILE The name of the output file

What is new in this release:

• Bugfix: didn't show sub documents when the subdocs were longer than the parent doc.

What is new in version 0.3.2:

• Bugfix: bombed when the value of a field was {}

What is new in version 0.3.1:

• Forgot to update the changelog on 0.3
• Minor edit in README.rst.

What is new in version 0.2 Beta:

• Fixed a bug in counting similar docs
• When the user keeps saying no to the 'use this doc' prompt

What is new in version 0.2 Alpha:

• Added a simple method to help find the most representative doc in each collection
• Added a class that finds links between collections and draws lines between them

Requirements:

• Python