mymongo
A Python package for effortless object-document mapping using pymongo and pydantic to interface with MongoDB.
Using
To add and install this package as a dependency of your project, run poetry add mymongo.
Example
from typing import Any
from mymongo import Document, Store
from pydantic import BaseModel, EmailStr
from pymongo import MongoClient
from querytyper import MongoFilterMeta, MongoQuery
class User(BaseModel):
"""User model."""
name: str
age: int
email: EmailStr
class UserInDb(User, Document):
"""User database model."""
class UserFilter(UserInDb, metaclass=MongoFilterMeta):
"""User query filter."""
client: MongoClient[dict[str, Any]] = MongoClient()
collection = client.get_database(name="db_name").get_collection(name="collection_name")
store = Store[User, UserInDb](collection)
first_id = store.create(User(name="John", age=11, email="john@example.com")).id
second_id = store.create(User(name="John", age=13, email="j@example.com")).id
store.create(User(name="Al", age=12, email="al@example.com"))
query = MongoQuery((UserFilter.name == "John") & (UserFilter.age >= 10))
store.delete(first_id)
found = store.find(query)
found[0]
UserInDb(
id=ObjectId('65bfa898110076608a191c36'),
created_at=datetime.datetime(2024, 2, 4, 15, 9, 12, 47000),
updated_at=datetime.datetime(2024, 2, 4, 15, 9, 12, 47000),
deleted_at=None,
name='John',
age=13,
email='j@example.com'
)
Contributing
Prerequisites
1. Set up Git to use SSH
- Generate an SSH key and add the SSH key to your GitHub account.
- Configure SSH to automatically load your SSH keys:
cat << EOF >> ~/.ssh/config Host * AddKeysToAgent yes IgnoreUnknown UseKeychain UseKeychain yes EOF
2. Install Docker
- Install Docker Desktop.
- Enable Use Docker Compose V2 in Docker Desktop's preferences window.
- Linux only:
- Configure Docker to use the BuildKit build system. On macOS and Windows, BuildKit is enabled by default in Docker Desktop.
- Export your user's user id and group id so that files created in the Dev Container are owned by your user:
cat << EOF >> ~/.bashrc export UID=$(id --user) export GID=$(id --group) EOF
3. Install VS Code or PyCharm
- Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.
- Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or configure PyCharm to use it.
Development environments
The following development environments are supported:
- ⭐️ GitHub Codespaces: click on Code and select Create codespace to start a Dev Container with GitHub Codespaces.
- ⭐️ Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.
- Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.
- PyCharm: clone this repository, open it with PyCharm, and configure Docker Compose as a remote interpreter with the
devservice. - Terminal: clone this repository, open it with your terminal, and run
docker compose up --detach devto start a Dev Container in the background, and then rundocker compose exec dev zshto open a shell prompt in the Dev Container.
Developing
- This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
- Run
poefrom within the development environment to print a list of Poe the Poet tasks available to run on this project. - Run
poetry add {package}from within the development environment to install a run time dependency and add it topyproject.tomlandpoetry.lock. Add--group testor--group devto install a CI or development dependency, respectively. - Run
poetry updatefrom within the development environment to upgrade all dependencies to the latest versions allowed bypyproject.toml. - Run
cz bumpto bump the package's version, update theCHANGELOG.md, and create a git tag.
Metadata
Release files for mymongo 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mymongo-0.1.1.tar.gz | 9.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mymongo-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 19.0 kB
Release files / mymongo-0.1.1.tar.gz
| Download URL | mymongo-0.1.1.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4f45579b38fd58e06e372e5f45ae59d64b5a8ffe175bb5c6859b4ef749b22ef5
|
|
BLAKE2b-256 checksum How to use checksums |
1c1e8af9894871ccf6879dde324e3d000afe1afc32089411bffb6e10395fdf62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1019-azure
|
Release files / mymongo-0.1.1-py3-none-any.whl
| Download URL | mymongo-0.1.1-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2d69804e530d9bd53ed783095561674643553eccf69eec3c8b50bee2ae7deb9b
|
|
BLAKE2b-256 checksum How to use checksums |
8f02734c4dd085c53ee79a702a2a935f55c079f1d327994804eb117327746933
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1019-azure
|