mongo2md: a command-line tool for MongoDB documentation generation

mongo2md is a command line tool for MongoDB documentation generation It generates mock files from Mongo database, allows you to add comments and builds Markdown files

Contents

• 1   Main features
• 2   Installation
  • 2.1   macOS
  • 2.2   Linux
  • 2.3   Windows, etc.
  • 2.4   Python version
• 3   Usage
  • 3.1   How to use
  • 3.2   Examples

1   Main features

• Database schema identification
• Mock files generation
• Build-in Markdown generation
• Low memory footprint
• Documentation
• Test coverage

2   Installation

2.1   macOS

On macOS, undatum can be installed via Homebrew (recommended):

$ brew install mongo2md

A MacPorts port is also available:

$ port install mongo2md

2.2   Linux

Most Linux distributions provide a package that can be installed using the system package manager, for example:

# Debian, Ubuntu, etc.
$ apt install mongo2md

# Fedora
$ dnf install mongo2md

# CentOS, RHEL, ...
$ yum install mongo2md

# Arch Linux
$ pacman -S mongo2md

2.3   Windows, etc.

A universal installation method (that works on Windows, Mac OS X, Linux, …, and always provides the latest version) is to use pip:

# Make sure we have an up-to-date version of pip and setuptools:
$ pip install --upgrade pip setuptools

$ pip install --upgrade mongo2md

(If pip installation fails for some reason, you can try easy_install mongo2md as a fallback.)

2.4   Python version

Python version 3.6 or greater is required.

3   Usage

Synopsis:

$ mongo2md [flags] prepare dbname [collname]

See also mongo2md --help.

3.1   How to use

1. Run mongo2md prepare command with selected database
2. Go to the directory with generated files
3. Edit '*_fields.csv' and 'tables.csv' files, add "displayName" and "description" fields. Make sure to use utf -8
4. Run python -m mongo2md document will generate Markdown files for

3.2   Examples

Build mock files from 'budgetreg' database with 'budgetreg' collection and store to 'projects/budgetreg' directory

$ mongo2md prepare --output projects/budgetreg budgetreg budgetreg

Builds markdown

$ mongo2md document projects/budgetreg