MongoDB with μMongo ODM support for Sanic framework
Project description
MongoDB with μMongo ODM support for Sanic framework
Features
Uses motor_asyncio package for async queries to MongoDB
Good integrated with uMongo ODM, so that you can use it easily in your projects
Installation
This package should be installed using pip:
pip install sanic-mongodb-extension
Example
#!/usr/bin/env python3
from sanic import Sanic, response
from sanic_mongodb_ext import MongoDbExtension
from umongo import Instance, Document, MotorAsyncIOInstance
from umongo.fields import StringField
app = Sanic(__name__)
# Configuration for MongoDB and uMongo
app.config.update({
"MONGODB_DATABASE": "app", # Make ensure that the `app` database is really exists
"MONGODB_URI": "mongodb://root:root@mongodb:27017",
"LAZY_UMONGO": MotorAsyncIOInstance(),
})
# uMongo client is available as `app.mongodb` or `app.extensions['mongodb']`.
# The lazy client will be available as `app.lazy_mongodb` only when the database was specified,
# and which is a great choice for the structured projects.
MongoDbExtension(app)
# Describe the model
@app.lazy_umongo.register
class Artist(Document):
name = StringField(required=True, allow_none=False)
# And use it later for APIs
@app.route("/")
async def handle(request):
artist = Artist(name="A new rockstar!")
await artist.commit()
return response.json(artist.dump())
if __name__ == '__main__':
app.run(host='0.0.0.0', port=8000)
License
The sanic-mongodb-extension is published under BSD license. For more details read LICENSE file.
Real project examples
Open Matchmaking project:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sanic-mongodb-extension-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2f3eae8ade7eed57338275ae1d9a017c83b38a36a8718f6e67158cfe347acb7 |
|
MD5 | 4cb076327fea201d71b16acc48e7e1d6 |
|
BLAKE2b-256 | 8830971015ec0d451b65a06f894444a0990cac27001c17e0094903e8bc4ca7e6 |
Close
Hashes for sanic_mongodb_extension-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79ebfd16e50391d544372ba61a7a219f48cbbff1f7cd828ac833a0cafc46ea47 |
|
MD5 | 2842da7e66be14367a8a740d359fce2c |
|
BLAKE2b-256 | 0529576e3b03cea7ecfd0a72d252721960fa35145e0543ff148b01d93dc58a6e |