{ "info": { "author": "Craig Swank", "author_email": "craigswank@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "If you have a mongodb database that you wish to document, a good\nstarting point might be to install mongodoc and use the mongodoc\ncommand::\n\n % mongodoc test\n\nAfter answering a few questions, you will get an output file that\nwill look something like this::\n\n\n _____________________________________________\n | hobbies |\n |_____________________________________________|\n +--| _id: |\n | | title: |\n | |_____________________________________________|\n | \n | _____________________________________________\n | | occupations |\n | |_____________________________________________|\n +--+--| _id: |\n | | | duties: |\n | | | title: |\n | | |_____________________________________________|\n | | \n | | ____________________________________________________________________________________\n | | | people |\n | | |____________________________________________________________________________________|\n | | | _id: ________________________________|\n | | | address: | address ||\n | | | first: |________________________________||\n | +--| hobby: | number: ||\n | | last: | state: ||\n +-----| occupation: | street: ||\n | | zip: ||\n | |________________________________||\n |____________________________________________________________________________________|\n \n\nThe document in the people collection has a sub-document for\nthe value of the address field, so it appears as a box within \nthe people diagram. You will get one of these diagrams for each\ncollection in the db. MongoDoc found that there is a probable\nlink between the _id of occupations and the occupation field\nof the people doc. If the find links feature is not working\nfor you, you can disable it with the --find-links option\n\nThe mongodoc command has a few options for connecting to the db::\n\n % mongodoc -h \n usage: mongodoc [-h] [--port PORT] [--host HOST] [--username USERNAME]\n [--password PASSWORD] [--file FILE]\n name\n\n Document a mongo db\n\n positional arguments:\n name The name of the mongo db to document\n\n optional arguments:\n -h, --help show this help message and exit\n --port PORT The db port number\n --host HOST The db host\n --username USERNAME The username for authenticating to the db\n --password PASSWORD The password for authenticating to the db\n --file FILE The name of the output file\n --find-links Enter no if you don't want to find links.\n\n\n\nChangelog\n=========\n\n0.3.3\n-------------------\n- Bugfix: didn't show sub documents when the subdocs were longer than the parent doc.\n0.3.2\n-------------------\n- Bugfix: bombed when the value of a field was {}\n\n0.3.1\n-------------------\n- Forgot to update the changelog on 0.3\n- Minor edit in README.rst.\n\n0.3\n-------------------\n- Changed the console command\n from doc-db to mongodoc\n- Fixed easy_install problem\n because of a missing HISTORY\n file - OOPS!\n\n0.2b\n-------------------\n- Fixed a bug in counting similar docs\n- When the user keeps saying no to the\n 'use this doc' prompt\n\n0.2a\n-------------------\n- Added a simple method to help find the most \n representative doc in each collection\n- Added a class that finds links between\n collections and draws lines between them\n\n\n0.1\n-------------------\n\n- Initial release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/cswank/mongodoc", "keywords": "mongodb database schema documentation", "license": "MIT License", "maintainer": null, "maintainer_email": null, "name": "mongodoc", "package_url": "https://pypi.org/project/mongodoc/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/mongodoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/cswank/mongodoc" }, "release_url": "https://pypi.org/project/mongodoc/0.3.3/", "requires_dist": null, "requires_python": null, "summary": "Creates a uml-like diagram for a nested mongodb document", "version": "0.3.3" }, "last_serial": 794942, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "169889e9a000f4e834e666bc13cd5d62", "sha256": "388cef7c4925f612eac571d5669cd8e30952c5a31a1d75b3e27740ae1e084b8d" }, "downloads": -1, "filename": "mongodoc-0.1.tar.gz", "has_sig": false, "md5_digest": "169889e9a000f4e834e666bc13cd5d62", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3883, "upload_time": "2011-08-02T21:46:29", "url": "https://files.pythonhosted.org/packages/3b/be/fd16793fdfb3fc7256166d72d04736b4c1f613749bff6f3f8b86dd61d957/mongodoc-0.1.tar.gz" } ], "0.1dev": [], "0.2a": [ { "comment_text": "", "digests": { "md5": "aec175945ca4c910b75960a169005aea", "sha256": "f7577d1bc70ec8d2c218355293e4f2dba7cabf04ae3ae3e0c794d8fb2a344982" }, "downloads": -1, "filename": "mongodoc-0.2a.tar.gz", "has_sig": false, "md5_digest": "aec175945ca4c910b75960a169005aea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5576, "upload_time": "2011-08-05T02:03:15", "url": "https://files.pythonhosted.org/packages/0c/d9/818396deffcd86064e41a6e44206ff2bd9fa2c145d810d98edbb98209944/mongodoc-0.2a.tar.gz" } ], "0.2b": [ { "comment_text": "", "digests": { "md5": "221a0a4f4e66539092e5267fa2b0a554", "sha256": "72fbd2ee6ebcaa425885def4092a6009f3fd376fdb7417f1e620865442c992c6" }, "downloads": -1, "filename": "mongodoc-0.2b.tar.gz", "has_sig": false, "md5_digest": "221a0a4f4e66539092e5267fa2b0a554", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5762, "upload_time": "2011-08-05T14:42:16", "url": "https://files.pythonhosted.org/packages/e2/a8/ed1f94fc2f0f01de8ccfd3b20693fe09cd591bf9cc127f89d7a18a936521/mongodoc-0.2b.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "b7b8ec4a5460d24f13cb28608f0eea8a", "sha256": "4ce754bb24c179fc9a190625865259196dc0b29a39d003dde330b8d046d3143b" }, "downloads": -1, "filename": "mongodoc-0.3.tar.gz", "has_sig": false, "md5_digest": "b7b8ec4a5460d24f13cb28608f0eea8a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6572, "upload_time": "2011-11-01T22:58:04", "url": "https://files.pythonhosted.org/packages/48/9e/923e977ed9b22d0659f2a735dba05efaf6824f47f59f8f0f3ec641a0df15/mongodoc-0.3.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "757cd7ec8b734531fe1d7cf9cc62c8dc", "sha256": "dac96bd428375a2b9bc157d1fed87f83fee934bebef65c9651be408bf3cf4238" }, "downloads": -1, "filename": "mongodoc-0.3.1.tar.gz", "has_sig": false, "md5_digest": "757cd7ec8b734531fe1d7cf9cc62c8dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6715, "upload_time": "2011-11-02T15:34:13", "url": "https://files.pythonhosted.org/packages/c8/6c/0a2d868693fa40c10bf733287bf95794722970f97a1c024259367e644744/mongodoc-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "ff84a2eef596edd75620b8271ea139d2", "sha256": "213033c7c62f5816fd8c391b4f663f2f6822624a0cd5721c101f51979548e3a0" }, "downloads": -1, "filename": "mongodoc-0.3.2.tar.gz", "has_sig": false, "md5_digest": "ff84a2eef596edd75620b8271ea139d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6779, "upload_time": "2011-12-02T18:42:59", "url": "https://files.pythonhosted.org/packages/22/5d/cc58ce65d3da5b76ee57c533de68629d5f309670492478269ba7d56a3367/mongodoc-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "c627761b50e36258bd32cf326dc422a2", "sha256": "c442cdf596ee5e8048ee062be71b7fbae04d3c146d00673e22229e79ea7d0e93" }, "downloads": -1, "filename": "mongodoc-0.3.3.tar.gz", "has_sig": false, "md5_digest": "c627761b50e36258bd32cf326dc422a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6866, "upload_time": "2012-01-06T01:09:55", "url": "https://files.pythonhosted.org/packages/b2/be/7d39ade1e2d994e99102bd4444a27b5ec1c92d42f2516e106977e35f5910/mongodoc-0.3.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c627761b50e36258bd32cf326dc422a2", "sha256": "c442cdf596ee5e8048ee062be71b7fbae04d3c146d00673e22229e79ea7d0e93" }, "downloads": -1, "filename": "mongodoc-0.3.3.tar.gz", "has_sig": false, "md5_digest": "c627761b50e36258bd32cf326dc422a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6866, "upload_time": "2012-01-06T01:09:55", "url": "https://files.pythonhosted.org/packages/b2/be/7d39ade1e2d994e99102bd4444a27b5ec1c92d42f2516e106977e35f5910/mongodoc-0.3.3.tar.gz" } ] }