Mongo Box helps starting and stopping sandboxed MongoDB instance
from within a Python process. MongoDB instance is created with a
temporary directory to store database file and is configured to
be as lightweight as possible. It will choose a free port on localhost,
so it will not interfere with default MongoDB processes.
It is primarily expected to be used in unit tests and for prototyping concepts.
A typical use of a Mongo Box:
from mongobox import MongoBox
box = MongoBox()
client = box.client() # pymongo client
# do stuff with Mongo
assert not client.alive()
Mongo Box comes with a Nose plugin which is automatically installed.
If used as a plugin, port of the running instance will be exported
in environment variable `MONGOBOX_PORT`. This name can be overridden
The plugin exposes several configuration options. To see them, run:
The options you are interested in start with `--mongobox-`.
`nose2.cfg` should look similar to this:
plugins = mongobox.nose2_plugin
# Optionally specify the path to the mongod executable
# bin =
# Optionally specify the port to run mongodb on
# port =
# Optionally enable mongodb script engine
# scripting = True
# Path to database files directory. Creates temporary directory by default
# dbpath =
# Optionally store the mongodb log here (default is /dev/null)
# logpath =
# Optionally preallocate db files
# prealloc = True
# Which environment variable port number will be exported to
port_envvar = MONGOBOX_PORT
For an easy unit tests integration there is a `MongoTestCase` class
inherited from `unittest.TestCase`. It assumes tests are run from `nosetests`
with `--with-mongobox` flag. `MongoTestCases` provides a `pymongo` client
connected to the sandboxed mongo instance and a `purge_database` helper
to clean up the database after every test:
from mongobox.unittest import MongoTestCase
Get it from PyPi:
pip install mongobox
Get it from GitHub:
pip install https://github.com/theorm/mongobox.git
MongoBox is based on `mongonose` nose plugin by Kapil Thangavelu.
For a list of contributors see `AUTHORS.md`.
TODO: Brief introduction on what you do with files - including link to relevant help section.