README.md

pymongobox

Set of tools allowing the operation of a mongodb database

• Requirements
• Package install
• crud
• streaming
  • Default streaming
  • Custom logs processing

Requirements

• System requirements:
  • mongodb 4.2 or higher
  • mongodb replica set available

Package install

• pip install .

crud

CRUD operations create, read, update, and delete documents.

from pymongobox.crud import crud

• Set configuration for a collection

my_collection = crud.MongoDB("mongodb://localhost:27017", "database_name", "collection_name")

• insert

doc = {"field1" : "value"}
my_collection._insert(doc)

• update

# my_collection._update(filter,update_data, upsert, many)
my_collection._update({"field1" : "value"},{"field1" : "value2", "field2" : [1,2,3]}, False, True)

• find

_filter = {}
cursor = my_collection.find(_filter)
my_collection._process_cursor(cursor)

streaming

streaming package is a simple mongodb streaming service based on mongodb change streams feature.

The service allows to launch asynchronous streams in parallel.

from pymongobox.streaming import services

Default streaming

By Default, the stream prints new logs in console.

• Set configuration for multiple mongoDB collections :

stream_config1 = ["mongodb://localhost:27017","database_name","collection_name1"]
stream_config2 = ["mongodb://localhost:27017","database_name","collection_name2"]
stream_config=(stream_config1,stream_config2)

• Init the worker

# Worker(number of cpu you want to allocate, stream configurations)
worker = services.Worker(2, stream_config)

• Run

worker.pool_handler()

Custom logs processing

Provides a way to run a custom function on each new stream log of collection

from pymongobox.streaming import services

def custom_process(**kwargs): 
    for k,v in kwargs.items(): 
        print(k, v)

if __name__=="__main__":
    stream_config1 = ["mongodb://localhost:27017","database_name","collection_name1", custom_process]
    stream_config2 = ["mongodb://localhost:27017","database_name","collection_name2", custom_process]
    stream_config=(stream_config1,stream_config2)
    worker = services.Worker(2, stream_config)

    worker.pool_handler()