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.0.tar.gz (5.6 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.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdb_models-3.0.0.tar.gz
  • Upload date:
  • Size: 5.6 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.0.tar.gz
Algorithm Hash digest
SHA256 f52995d41db03da32bad362913db2dfbfb754cadfa2a4ba32d078c04de21d249
MD5 4ebbd9ba35dfa171d96317c8351d7cd2
BLAKE2b-256 51d2b6d2ad6da4dbf9b618e3bce1886e8ae12745de23e0d9a8c18ee564efdad9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdb_models-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 10.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79dda0a078500c1c1f5b6e52f5eb28a5de27f1e17b3f0badca7542140a89dd4e
MD5 854c17c9cc73fbd02594e6b7aaee6ef4
BLAKE2b-256 030875ff1dabbb3955c326be3174767c06119bcfb22e22d7d3ffcd7eb06b9ff5

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