Viter

class viter.viter.Viter

Main interface class

generate(**kwargs)

Generate an invitation

get(hash, **kwargs)

Get an invitation object from the hash

invite_emails(emails, **kwargs)

Generate and send invitations to a list of emails

register_usage(hash, **kwargs)

Send by mail an invitation

send_by_mail(invitation, **kwargs)

Send by mail an invitation

StoreHandlers

class viter.storehandlers.storehandlerbase.StoreHandlerBase

Abstract class for Store Handlers

create(hash, **kwargs)

Abstract method

get(hash, **kwargs)

Abstract method

register_usage(hash, **kwargs)

Abstract method

class viter.storehandlers.nostorehandler.NoStoreHandler

Fake Store Handler, do nothing

create(hash, **kwargs)

do nothing and return None

get(hash, **kwargs)

do nothing and return None

register_usage(hash, **kwargs)

do nothing and return True

class viter.storehandlers.dbstorehandler.DBStoreHandler

DB Store Handler, store the data in django models

create(hash, **kwargs)

Create a new invitation object

get(hash, **kwargs)

Get an invitation from the hash

register_usage(hash, **kwargs)

Register the usage of an invitation

GeneratorHandlers

class viter.generatorhandlers.generatorhandlerbase.GeneratorHandlerBase

Abstract class for Generator Handlers

generate(**kwargs)

Abstract method

class viter.generatorhandlers.nogeneratorhandler.NoGeneratorHandler

Fake Generator Handler, do nothing

generate(**kwargs)

do nothing and return None

class viter.generatorhandlers.uuidgeneratorhandler.UUIDGeneratorHandler

UUID based Generator handler

generate(**kwargs)

return a new invitation hash generated with uuid4

SendmailHandlers

class viter.sendmailhandlers.sendmailhandlerbase.SendmailHandlerBase

Abstract class for Sendmail Handlers

send(invitation, **kwargs)

Abstract method

class viter.sendmailhandlers.nosendmailhandler.NoSendmailHandler

Fake Sendmail Handler, do nothing

send(invitation, **kwargs)

do nothing and return True

class viter.sendmailhandlers.plainsendmailhandler.PlainSendmailHandler

Plain text Sendmail handler

send(invitation, **kwargs)

Send an invitation to kwargs[‘email’] or invitation.email

Generate the email text from the templates viter/email/subject.txt and viter/email/body.txt with **kwargs and invitation in the context.