Skip to main content

A data mapper for mongodb (Formerly mongodb_data_layer)

Project description

MongoDB Data Layer

A data modeling MongoDB library for Python


Installation

  1. Install the python package via pip:
pip install mdb-models

Note: It is better to create a python virtual environment...

  1. Setup an environment variables:

    • To create an environment variables, simply create a file named ".env".
    • Then, add these following variables to a created file:
    MONGO_DB_URL="mongodb://localhost:27020" # The default mongodb localhost but you can also put a connection string from atlas server.
    MONGO_DB_NAME="my_database" # Your created database
    
  2. To create a model you can simply enter this command on a command promt:

generate-model /models/test.py  # where '/models/test_model.py' is your file path and file name

# ============== or ===============

generate-authmodel /models/user.py # creates an authenticatable model
  1. It will generate a file like this:
#A MongoDB model for the tests collection
from mdb_models.base import BaseMongoModel

class Test(BaseMongoModel):
    
    collection_name = 'tests' # Create a collection with this name in the database

Notes

This library is very useful to lessen the configuration for mongodb database.

This package is build on top of MongoDB official package/drivers.

This is also works well in fastapi.

This library is currently in development. Feel free to contribute.


Official repository: https://github.com/nojram00/mongodb-data-layer

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

mdb_models-3.0.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdb_models-3.0.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file mdb_models-3.0.1.tar.gz.

File metadata

  • Download URL: mdb_models-3.0.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for mdb_models-3.0.1.tar.gz
Algorithm Hash digest
SHA256 0b599aac092a648be8777ae9e90658086e6fb1946929fbb79c8329bf72990567
MD5 6ba13cb24bea1190ffab22469ca2972a
BLAKE2b-256 34de40f9424d304e4aca38ad375bceb09e4adda1f8888e86f9ef2afa0cacdced

See more details on using hashes here.

File details

Details for the file mdb_models-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: mdb_models-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for mdb_models-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ed1c724fedb07e1db4eb1c4730d7bed3178a2b97dc83112d1378ef7240d7ac4
MD5 f266f46dd03fc0c1bb1790f9172aa535
BLAKE2b-256 8b8d047034100b13e788611da43294a13be6c57f0e6572569a5fe6a0e95abfc9

See more details on using hashes here.

Supported by

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