Skip to main content
Mongo Box
---------

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:

```python
from mongobox import MongoBox

box = MongoBox()
box.start()

client = box.client() # pymongo client
print(client.server_info())

# do stuff with Mongo

box.stop()
try:
client.server_info()
except:
print('Mongo instance is stopped')
```

Nose 1
------

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
in settings.

The plugin exposes several configuration options. To see them, run:

nosetests --help

The options you are interested in start with `--mongobox-`.

Nose 2
------

`nose2.cfg` should look similar to this:

```ini
[unittest]
plugins = mongobox.nose2_plugin

[mongobox]
# 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
```

Unit tests
----------

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:

```python
from mongobox.unittest import MongoTestCase

class MyTest(MongoTestCase):
def setUp(self):
deploy_fixtures(self.mongo_client)

def tearDown(self):
self.purge_database()
```

Installation
------------

Get it from PyPi:

pip install mongobox

Get it from GitHub:

pip install https://github.com/theorm/mongobox.git



Authors
=======

Roman Kalyakin


Thanks
------

MongoBox is based on `mongonose` nose plugin by Kapil Thangavelu.

For a list of contributors see `AUTHORS.md`.

Metadata

Release files for mongobox 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mongobox 0.1.8
File Size Uploaded Provenance Actions
mongobox-0.1.8.tar.gz 7.7 kB Without provenance Details for mongobox-0.1.8.tar.gz

Release files / mongobox-0.1.8.tar.gz

Download URL mongobox-0.1.8.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
52e82df1c70cef0204ce2cfa850041a60947aeef3f8d79d718a1469b5a850f37
BLAKE2b-256 checksum
How to use checksums
e74b4922f5533f1bc1c259aeec34aec4a6273fd11b886cf08915d25a67083910
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

Security for mongobox 0.1.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page