API

Plugins

GwUsersWebManager

class groundwork_users.plugins.GwUsersWebManager(app, *args, **kwargs)

Patterns

GwUsersPattern

class groundwork_users.patterns.GwUsersPattern(app, *args, **kwargs)

users = None

Instance of UsersPlugin. Provides functions to register and manage users

Users

The following functions are available inside each plugin, which inherits from GwUsersPattern via self.users.

class groundwork_users.patterns.gw_users_pattern.users.UsersPlugin(plugin)

delete(user_name)

get(user_name=None, **kwargs)

register(user_name, email, password, full_name='', page=None, description=None, domain=None, groups=None, roles=None, permissions=None, confirmed_at=None, active=True)

class groundwork_users.patterns.gw_users_pattern.users.UsersApplication(app)

delete(user_name, plugin=None)

get(user_name=None, plugin=None, **kwargs)

register(user_name, email, password, full_name=None, page=None, description=None, plugin=None, domain=None, groups=None, roles=None, permissions=None, confirmed_at=None, active=True)

Errors

class groundwork_users.patterns.gw_users_pattern.users.NoUserDatabaseException

class groundwork_users.patterns.gw_users_pattern.users.NoUserTableException

class groundwork_users.patterns.gw_users_pattern.users.UserDoesNotExistException

Groups

The following functions are available inside each plugin, which inherits from GwUsersPattern via self.groups.

class groundwork_users.patterns.gw_users_pattern.groups.GroupsPlugin(plugin)

delete(group_name)

get(group_name=None)

register(name, description=None, users=None, permissions=None, roles=None)

class groundwork_users.patterns.gw_users_pattern.groups.GroupsApplication(app, users_db)

delete(group_name, plugin=None)

get(group_name=None, plugin=None, **kwargs)

register(name, description=None, users=None, permissions=None, roles=None, plugin=None)