Package: horus
horusprovides generic user registration for the Pyramid web framework,
if your web app uses sqlalchemy.It is a pluggable web application that provides user registration,
login, logout and change password functionality.horusfollows a policy of
minimal interference, so your app can mostly keep its existing models.Minimal integrationCreate a virtualenv and activate it. Install pyramid and create
your pyramid project.Edit yoursetup.pyto add “horus” to the dependencies in theinstall_requireslist.Runpython setup.py developon your project to install all dependencies
into your virtualenv.Create your SQLAlchemy declarative initialization.Create models inheriting from horus’ abstract models. Find an example in the
filehorus/tests/models.py.Alternatively, use the horus scaffold script:horus_scaffold development.ini > your_app/auth_models.pyThen all you need to do is tell the class where to find your declarative
base you and are good to go!Include horus inside yourmain()function like this:# Tell horus which SQLAlchemy scoped session to use:
from hem.interfaces import IDBSession
registry = config.registry
registry.registerUtility(my_sqlalchemy_scoped_session, IDBSession)

config.include('horus')
config.scan_horus(auth_models_package_or_module)With the aboveconfig.scan_horus()call, you need to edit your .ini
configuration file and tell horus which model classes to use like this:horus.user_class = my_app.models:User
horus.activation_class = my_app.models:ActivationAs an alternative toconfig.scan_horus()plus that configuration,
you can register the classes explicitly if you so prefer. This must be
done aboveconfig.include('horus'):# Tell horus which models to use:
from horus.interfaces import IUserClass, IActivationClass
registry.registerUtility(User, IUserClass)
registry.registerUtility(Activation, IActivationClass)

config.include('horus')Configurehorus.login_redirectandhorus.logout_redirect(in your .ini configuration file) to set the redirection routes.If you haven’t done so yet, configure an HTTP session factory according to
the Sessions chapter of the Pyramid documentation.Create your database and tables. Maybe even an initial user.Be sure to pass anauthentication_policyargument in theconfig =Configurator(...)call. Refer to Pyramid docs for details.By now the login form should appear at /login, but /register shouldn’t.Include the package pyramid_mailer for the validation e-mail and
“forgot password” e-mail:config.include('pyramid_mailer')The /register form should appear, though ugly. Now you have a choice
regarding user activation by email:You may just disable it by setting, in your .ini file:horus.require_activation = FalseOtherwise, configure pyramid_maileraccording to its documentationand test the registration page.If you are using pyramid_tm or the ZopeTransactionManager, your minimal
integration is done. (The pages are ugly, but working. Keep reading…)Need to session.commit()?horusdoes not require pyramid_tm or the ZopeTransactionManager with your
session but if you do not use them you do have to take one extra step.
We don’t commit transactions for you because that just wouldn’t be nice!All you have to do is subscribe to the extension events and
commit the session yourself. This also gives you the chance to
do some extra processing:from horus.events import (
    PasswordResetEvent, NewRegistrationEvent,
    RegistrationActivatedEvent, ProfileUpdatedEvent)

def handle_request(event):
    request = event.request
    session = request.registry.getUtility(IDBSession)
    session.commit()

self.config.add_subscriber(handle_request, PasswordResetEvent)
self.config.add_subscriber(handle_request, NewRegistrationEvent)
self.config.add_subscriber(handle_request, RegistrationActivatedEvent)
self.config.add_subscriber(handle_request, ProfileUpdatedEvent)Changing the formsIf you would like to modify any of the forms, you just need
to register the new deform class to be used.The interfaces you have available to override from horus.interfaces are:IHorusLoginFormIHorusRegisterFormIHorusForgotPasswordFormIHorusResetPasswordFormIHorusProfileFormThis is how you would do it (MyFormbeing a custom deform Form class):config.registry.registerUtility(MyForm, IHorusLoginForm)Changing the templatesIf you would like to substitute the templates you can use pyramid’soverride_asset:config.override_asset(to_override='horus:templates/template.mako',
    override_with='your_package:templates/anothertemplate.mako')The templates you have available to override are:login.makoregister.makoforgot_password.makoreset_password.makoprofile.makoIf you would like to override the templates with Jinja2, or any other
templating language, just override the view configuration:config.add_view('horus.views.AuthController', attr='login',
    route_name='login', renderer='yourapp:templates/login.jinja2')
config.add_view('horus.views.ForgotPasswordController',
    attr='forgot_password', route_name='forgot_password',
    renderer='yourapp:templates/forgot_password.jinja2')
config.add_view('horus.views.ForgotPasswordController',
    attr='reset_password', route_name='reset_password',
    renderer='yourapp:templates/reset_password.jinja2')
config.add_view('horus.views.RegisterController', attr='register',
    route_name='register', renderer='yourapp:templates/register.jinja2')
config.add_view('horus.views.ProfileController', attr='profile',
    route_name='profile', renderer='yourapp:templates/profile.jinja2')Changing stringsTake a look atthis class.
This is where we store all the strings in horus.
If you’d like to change one or two messages, simply subclass this, then do:from horus.interfaces import IUIStrings
config.registry.registerUtility(MyStringsClass, IUIStrings)Changing the primary key column nameIf you wish to override the primary key attribute name, you can do so
by creating a new mixin class:class NullPkMixin(Base):
    abstract = True
    _idAttribute = 'pk'

    @declared_attr
    def pk(self):
        return Base.pk

    @declared_attr
    def id(self):
        return None

class User(NullPkMixin, UserMixin):
    passhorus developmentSeehttps://github.com/eventray/horusIf you would like to help make any changes to horus, you can run its
unit tests with py.test:py.testTo check test coverage:py.test --cov-report term-missing --cov horusThe tests can also be run in parallel:py.test -n4We are using this build server:http://travis-ci.org/#!/eventray/horus