https://github.com/sivel/happymongo

Python module for making it easy and consistent to connect to MongoDB via PyMongo either in Flask or in a non-flask application
https://github.com/sivel/happymongo

Last synced: about 1 month ago
JSON representation

Python module for making it easy and consistent to connect to MongoDB via PyMongo either in Flask or in a non-flask application

• Host: GitHub
• URL: https://github.com/sivel/happymongo
• Owner: sivel
• License: apache-2.0
• Created: 2013-07-23T16:41:09.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-04-16T15:27:20.000Z (over 9 years ago)
• Last Synced: 2024-11-22T16:44:43.385Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 163 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HapPyMongo

Python module for making it easy and consistent to connect to MongoDB via PyMongo either in Flask or in a non-flask application

## Usage

### config.py as referenced below

```python

MONGO_HOST = 'localhost'

MONGO_PORT = '27017'

MONGO_USERNAME = 'user'

MONGO_PASSWORD = 'password'

```

### Flask

```python

from flask import Flask

from happymongo import HapPyMongo

# Our apps config.py

import config

app = Flask(__name__)

app.config.from_object(config)

mongo, db = HapPyMongo(app)

```

### Python from import

```python

from happymongo import HapPyMongo

# Our apps config.py

import config

mongo, db = HapPyMongo(config)

```

### Python from dict

```python

from happymongo import HapPyMongo

config = {

    'MONGO_HOST': 'localhost'

}

mongo, db = HapPyMongo(config)

```

## Config directives

| Directive      | Description |

| -------------- | ----------- |

| MONGO_URI      | A [MongoDB URI](http://www.mongodb.org/display/DOCS/Connections#Connections-StandardConnectionStringFormat) which is used in preference of the other configuration variables. |

| MONGO_HOST     | The host name or IP address of your MongoDB server. Default: “localhost”. |

| MONGO_PORT     | The port number of your MongoDB server. Default: 27017. |

| MONGO_DATABASE | The database name to make available as the db attribute. Default: app.name for Flask or the filename of the including file without the .py extension |

| MONGO_USERNAME | The user name for authentication. Default: None |

| MONGO_PASSWORD | The password for authentication. Default: None |

| MONGO_KWARGS   | A dictionary of keyword arguments to send to [pymongo.MongoClient](http://api.mongodb.org/python/current/api/pymongo/mongo_client.html) |