-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,39 @@ | ||
# OmMongo (Object Relational Mapping for MongoDB) | ||
# OmMongo | ||
[![Documentation Status](https://readthedocs.org/projects/ommongo/badge/?version=latest)](http://ommongo.readthedocs.io/en/latest/?badge=latest) | ||
[![Build Status](https://travis-ci.org/bapakode/OmMongo.svg?branch=master)](https://travis-ci.org/bapakode/OmMongo) | ||
[![Coverage Status](https://coveralls.io/repos/github/bapakode/OmMongo/badge.svg?branch=master)](https://coveralls.io/github/bapakode/OmMongo?branch=master) | ||
|
||
This project is forked from MongoAlchemy project. | ||
OmMongo is Object Relational Mapping for MongoDB, this project is forked from MongoAlchemy project. | ||
|
||
-------- | ||
### Installation | ||
|
||
Install using Python PIP | ||
|
||
sudo pip install OmMongo | ||
|
||
or download this repository and run setup.py | ||
|
||
sudo python setup.py install | ||
|
||
### Documentation | ||
|
||
The documentation can be found here [https://ommongo.readthedocs.io/en/latest/index.html](https://ommongo.readthedocs.io/en/latest/index.html "OmMongo Documentation") | ||
|
||
### Test | ||
|
||
sudo pip install -r requirements.testing.txt | ||
|
||
Test setup.py | ||
|
||
coverage run --source=ommongo setup.py test | ||
|
||
Nose Tests | ||
|
||
nosetests --cover-tests --cover-erase --with-coverage --cover-package ommongo | ||
|
||
### Release Notes | ||
|
||
##### v.1.0 | ||
|
||
- fork from MongoAlchemy project |