API Definition¶

App Kernel Engine¶

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

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)

Property¶

Validators¶

The base Validator class¶

Not Empty Validator¶

Regular Expression Validator¶

Email Validator¶

Minimum Validator¶

Maximum Validator¶

Past Validator¶

Future Validator¶

Unique Value Validator¶

Generators¶

UUID Generator¶

Date NOW Generator¶

Password hasher¶

Repository¶

The current implementation is the MongoRepository.

Query¶

MongoRepository¶

Auditable Repository¶

MongoQuery¶

Service¶