Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryu-cz/mongomancy
Pymongo based python client with data definition layer.
https://github.com/ryu-cz/mongomancy
Last synced: 1 day ago
JSON representation
Pymongo based python client with data definition layer.
- Host: GitHub
- URL: https://github.com/ryu-cz/mongomancy
- Owner: Ryu-CZ
- License: bsd-3-clause
- Created: 2022-09-02T09:24:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T10:47:37.000Z (9 days ago)
- Last Synced: 2024-10-30T11:34:08.694Z (9 days ago)
- Language: Python
- Size: 71.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Mongomancy
[](https://codecov.io/gh/Ryu-CZ/mongomancy)
## Description
Project contains abstraction of `pymongo` driver for automatic reconnect on master switch in remote MongoDB cluster. It
also provides data definition layer.
Core of `mongo_driver` is the `Engine` class, handling queries reconnection with notification to registered reconnect
hooks.
`Database` creates `Collection`s by their definitions. Database hooks itself to engine reconnect event, so it can switch
internal state of database's collections instances.
```mermaid
classDiagram
Executor <|-- Engine : implements
Database o-- Executor
Database *-- Collection
Database o-- CollectionDefinition
Collection o-- Executor
CollectionDefinition *-- Index
CollectionDefinition *-- Document
class Executor{
<>
reconnect()
register_hook(reconnect_hook_func)
find_one(collection: pymongo.collection.Collection, ...)
other_collection_methods(collection: pymongo.collection.Collection, ...)
}
class Engine{
+client: MongoClient
-_retry_command(collection, command, ...)
dispose()
reconnect()
register_hook(reconnect_hook_func)
find_one(collection: pymongo.collection.Collection, ...)
other_collection_methods(collection: pymongo.collection.Collection, ...)
}
class Collection{
+dialect_entity: pymongo.collection.Collection
+engine: Executor
+find_one(...)
other_collection_methods()
}
class Document{
+unique_key: Optional[BsonDict]
+data: BsonDict
}
class CollectionDefinition{
+name: str
+indices: Sequence[Index]
+default_docs: Sequence[Document]
}
class Index{
+fields: OrderedDictType[str, Union[str, int]]
+name: Optional[str]
+unique: Optional[bool]
field_for_mongo() -> List[Tuple[str, Union[str, int]]]
}
class Database{
+engine: Executor
+topology: List[types.CollectionDefinition]
-_database: pymongo.database.Database
-_collections: Dict[str, Collection]
invalidate_cache_hook(source: Engine)
get_collection(name: str) -> Collection
extend(*new_definitions: types.CollectionDefinition)
create_all(skip_existing: bool)
ping() -> bool
}
```
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew.
However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing
specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a
specific context like a particular programming language version or operating system or has dependencies that have to be
installed manually, also add a Requirements subsection.
## Usage
```python
import logging
from mongomancy import Engine, Database, CollectionDefinition, Index
engine = Engine("localhost", 27017)
logger = logging.getLogger(__name__)
db = Database(engine=engine, logger=logger)
game = CollectionDefinition(name="game", indices=[Index(fields={"genre": 1})])
player = CollectionDefinition(name="player", indices=[Index(fields={"player_id": 1}, unique=True)])
db.add_collection(game)
db.add_collection(player)
db.create_all()
db["game"].find({"genre": "adventure"})
```
## Tests
You can run tests with coverage tracing:
```shell
python -m coverage run -m unittest tests/test_* -v
```
To generate coverage report:
```shell
python -m coverage html
```
## Build
Clone repo and set up your pypi repo account credentials on build for build environment.
- Move to package repo:
```shell
cd ~/git/mongomancy
```
- Install requirements:
```shell
python -m pip install -Ur requirements.txt
```
- Clean old build fragments:
```shell
rm -rf ./dist ./build ./mongomancy/mongomancy.egg-info
```
- Build new package:
```shell
python -m build
```
- Upload new package:
```shell
python -m twine upload dist/*
```