Skip to content

Latest commit

 

History

History
160 lines (129 loc) · 3.19 KB

api.rst

File metadata and controls

160 lines (129 loc) · 3.19 KB

API Definition

App Kernel Engine

appkernel

The main application class, which exposes the Service classes, manages Repositories and applies security.

AppKernelEngine

Model

The base class to be extended by all Domain objects (Models). It has a set of useful methods, such as JSON marshaling, metadata (json schema) generation and validation. Example: :

class User(Model):
        id = Property(str)
        name = Property(str, required=True, index=UniqueIndex)
        email = Property(str, validators=Email, index=UniqueIndex)
        password = Property(str, validators=NotEmpty,
                             converter=content_hasher(), omit=True)

Model

Property

Property

Validators

The base Validator class

Validator

Not Empty Validator

NotEmpty

Regular Expression Validator

Regexp

Email Validator

Email

Minimum Validator

Min

Maximum Validator

Max

Past Validator

Past

Future Validator

Future

Unique Value Validator

Unique

Generators

UUID Generator

create_uuid_generator

Date NOW Generator

date_now_generator

Password hasher

content_hasher

Repository

The current implementation is the MongoRepository.

Repository

Query

Query

MongoRepository

MongoRepository

Auditable Repository

AuditableRepository

MongoQuery

MongoQuery

Service

Service