Skip to main content

A python interface to handle connection to a mongod instance

Project description


# Mongo Adapter

[![Build Status][travis-img]][travis-url]

A python implementation of a mongo adapter.

The idea is to make a base class that handles the connection to a mongod instance.
It is nice to handle the connection in the same way for different python projects that involves a mongo database.

The Mongo Adapter takes a client as init argument and then we connect to a database with `setup(database)`, forunately `mongo_adapter` can handle the client part as well.

**Example:**

```python
from mongo_adapter import MongoAdapter, get_client

db_name = 'test'
client = get_client()
adapter = MongoAdapter(client, db_name)

assert adapter.db_name == db_name
```

## installation

**git:**

```bash
git clone https://github.com/moonso/mongo_adapter
cd mongo_adapter
pip install --editable .
```

**pip:**
```bash
pip install mongo_adapter
```


## Intended usage

The intended usage is here illustrated with an example

```python
from mongo_adapter import MongoAdapter, get_client

class LibraryAdapter(MongoAdapter):
def setup(self, db_name='library'):
"""Overrides the basic setup method"""
if self.client is None:
raise SyntaxError("No client is available")
if self.db is None:
self.db = self.client[db_name]
self.db_name = db_name

self.books_collection = self.db.book
self.user_collection = self.db.book

def add_book(self, title, author):
"""Add a book to the books collection"""
result = self.books_collection.insert_one(
{
'title': title,
'author': author
}
)
return result

if __name__ == '__main__':
client = get_client()
adapter = LibraryAdapter(client, database='library')

adapter.add_book('Moby Dick', 'Herman Melville')

```

## API

### Client

```python

def check_connection(client):
"""Check if the mongod process is running

Args:
client(MongoClient)

Returns:
bool
"""

def get_client(host='localhost', port=27017, username=None, password=None,
uri=None, mongodb=None, timeout=20):
"""Get a client to the mongo database

Args:
host(str): Host of database
port(int): Port of database
username(str)
password(str)
uri(str)
timeout(int): How long should the client try to connect

Returns:
client(pymongo.MongoClient)

"""

```

### Adapter

```python
class MongoAdapter(object):
"""Adapter for communicating with a mongo database"""
def __init__(self, client=None, db_name=None):
"""
Args:
client(MongoClient)
db_name(str)
"""
self.client = client
self.db = None
self.db_name = None
if (db_name and client):
self.setup(database)

def init_app(self, app):
"""Setup via Flask"""
host = app.config.get('MONGO_HOST', 'localhost')
port = app.config.get('MONGO_PORT', 27017)
self.db_name = app.config['MONGO_DBNAME']
self.client = app.extensions['pymongo']['MONGO'][0]
self.db = app.extensions['pymongo']['MONGO'][1]
LOG.info("connecting to database: %s:%s/%s", host, port, self.db_name)
self.setup(self.db_name)

def setup(self, db_name):
"""Setup connection to a database

Args:
db_name(str)
db(pymongo.Database)
"""
if self.client is None:
raise SyntaxError("No client is available")
if self.db is None:
self.db = self.client[db_name]
self.db_name = db_name
LOG.info("Use database %s", self.db_name)

```


[travis-url]: https://travis-ci.org/moonso/mongo_adapter
[travis-img]: https://img.shields.io/travis/moonso/mongo_adapter/master.svg?style=flat-square



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mongo_adapter-0.1.2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

mongo_adapter-0.1.2-py2.py3-none-any.whl (7.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file mongo_adapter-0.1.2.tar.gz.

File metadata

File hashes

Hashes for mongo_adapter-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9dd07624004ea4963b9fc1d3aeb080b246111d13c3e3f06aefa0c8d15354a142
MD5 cb2218a94a86a57608c0cb5412ce7178
BLAKE2b-256 8749a8f49d82fdb55f92fe2dfb7c08b0500c3c7942a5da4f9584df5805c7c038

See more details on using hashes here.

File details

Details for the file mongo_adapter-0.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mongo_adapter-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 86e5c765d90258499d2f0e26c95a4a866b900aaf5b5dfae9a89678711f58499d
MD5 56e0c1d8f03f9fbe2aea0f72a09eb1b2
BLAKE2b-256 b6bd6a4ba206b4f78bf3c19ccee72ac36b1013593d45317acb80e2d8ba2b49b8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page