This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
If you have a mongodb database that you wish to document, a good
starting point might be to install mongodoc and use the mongodoc
command::

% mongodoc test

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


_____________________________________________
| hobbies |
|_____________________________________________|
+--| _id: <class 'bson.objectid.objectid'=""> |
| | title: <type 'unicode'=""> |
| |_____________________________________________|
|
| _____________________________________________
| | occupations |
| |_____________________________________________|
+--+--| _id: <class 'bson.objectid.objectid'=""> |
| | | duties: <type 'list'=""> |
| | | title: <type 'unicode'=""> |
| | |_____________________________________________|
| |
| | ____________________________________________________________________________________
| | | people |
| | |____________________________________________________________________________________|
| | | _id: <class 'bson.objectid.objectid'=""> ________________________________|
| | | address: <type 'dict'=""> | address ||
| | | first: <type 'unicode'=""> |________________________________||
| +--| hobby: <class 'bson.objectid.objectid'=""> | number: <type 'unicode'=""> ||
| | last: <type 'unicode'=""> | state: <type 'unicode'=""> ||
+-----| occupation: <class 'bson.objectid.objectid'=""> | street: <type 'unicode'=""> ||
| | zip: <type 'unicode'=""> ||
| |________________________________||
|____________________________________________________________________________________|


The document in the people collection 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. MongoDoc found that there is a probable
link between the _id of occupations and the occupation field
of the people doc. If the find links feature is not working
for you, you can disable it with the --find-links option

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

% mongodoc -h
usage: mongodoc [-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
--find-links Enter no if you don't want to find links.



Changelog
=========

0.3.3
-------------------
- Bugfix: didn't show sub documents when the subdocs were longer than the parent doc.
0.3.2
-------------------
- Bugfix: bombed when the value of a field was {}

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

0.3
-------------------
- Changed the console command
from doc-db to mongodoc
- Fixed easy_install problem
because of a missing HISTORY
file - OOPS!

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

0.2a
-------------------
- 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


0.1
-------------------

- Initial release
Release History

Release History

0.3.3

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.3.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.3.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.2b

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.2a

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1dev

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
mongodoc-0.3.3.tar.gz (6.9 kB) Copy SHA256 Checksum SHA256 Source Jan 6, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting