Bread¶

An object mapper for Cloud Datastore.

Getting Started¶

Check out the walkthrough.

Documentation¶

The documentation for Bread is available on Scribe.

Installation¶

Bread is available with pip via our private Artifactory repository:

pip install bread

Testing¶

Tests can be invoked with py.test. You will need:

A running Cloud Datastore development server:
- Install ``gcloud` <https://cloud.google.com/sdk/#Quick_Start>`_
- Run the emulator: ./bin/rundatastore
A running instance of memcached
- You may also skip Memcache-backend tests by setting SKIP_MEMCACHE as described below
Run the tests: py.test

An HTML coverage report will be produced after each test run and can be viewed at htmlcov/index.html after the test run.

Skipping Tests¶

Two test suites may be skipped by including relevant environment variables in the test run:

Setting SKIP_MEMCACHE will skip tests related to the Memcache backend
Setting SKIP_DATASTORE will skip Cloud Datastore tests. Note: Setting this implies SKIP_MEMCACHE as well.

Contributing¶

This project is collaboratively maintained. If you have issues or changes for the project, please open an issue or create a pull request, respectively.