traducteur 0.4.5

Traducteur is the middle man to handle your basic data needs.

Traducteur

Traducteur is a database model manager and task sheduler which aims to make developing basic app with database models and tasks faster and easier.

Requirements

• python ^3.8
• pydantic ^1.10.4

Optional

For mongo db:

• pymongo ^4.3.3

For task queueing or redis model management:

• redis-py ^4.4.2

Installation

Base install:

pip install traducteur

Install with extras:

pip install "traducteur[tasks]"

This example will install traducteur and all the packages you need to use traducteur tasks.

optional extras:

• sql
• nosql
• caching
• mongo
• tasks
• all

The idea

Context managers

with BaseContext(connection_string) as db:
    return db.get()

Model managers

Model managers use context managers

manager = BaseModelManager(connection_string)
result = manager.get(example_id)
result = manager.delete(example_id)

Models

Models use model managers

class User(BaseDatabaseModel):
    username: str
    fname: str
    lname: str
    email: str
    
user = User(
    username='johndoe',
    fname='John',
    lname='Doe',
    email='[e-mail]'
)

'''
    Easy create, save, update and delete
'''
user = User(
    username='johndoe',
    fname='John',
    lname='Doe',
    email='[e-mail]'
)

# saving the model
user = user.save()

# saving also updates the model
user.lname = 'Joe'
user = user.save()

# getting a model by its ID from the database
user = User.get(user_id)

# deleting a model from the database
deleted_user = user.delete()

Tasks

Tasks use models

# in a program
def my_func(a: int, b: int) -> int:
  return a + b

task = BaseTask(action=my_func)
task.queue(a=8, b=3)

###############
# in a worker #
task.digest() #
###############

# some time later
result = task.result()

Chain tasks

Tasks can be chained together for larger workloads

def double(number: int):
    return {
        'number': number * 2
    }

# make tasks
one = BaseTask(action=double)
two = BaseTask(action=double)
three = BaseTask(action=double)

# chain tasks
two.set_parent(one)
three.set_parent(two)

# queue parent task
one.queue(number=2)

###############
# in a worker #
one.digest()  #
###############

# some time later
result = one.result()
assert result == 8, "Should be 8 as 2*2*2 == 8"

Available functionality

Context managers

• MongoContext
• SQLite3Context

Model managers

• MongoModelManager
• SQLModelManager
  • SQLQueryBuilder

Query filters

• Datetime filter
• Number filter
• String filter

Models

• BaseMongoModel
• BaseRedisModel
• BaseSQLModel

Tasks

• RedisTask

Todo / in progress

Tasks

• Chain tasks
  • Redis
  • Mongo
  • SQL
• Task worker
  • Single Process
  • Multi Process
• RabbitMQ task

Tests

Tests can be found in the test folder. They use pythons unittest and can be run with:

python3 -m unittest path/to/test.py

Tests get automatically run after each push.

Available tests

• Mongo model
• Mongo sorting
• Redis task
  • Basic functions
  • Chaining