Source documentation

The sections below contain mostly autogenerated documentation of the source code of the Debian Member Portfolio Service.

Controllers

portfolio controller

error controller

class debianmemberportfolio.controllers.error.ErrorController[source]

Generates error documents as and when they are required.

The ErrorDocuments middleware forwards to ErrorController when error related status codes are returned from the application.

This behaviour can be altered by changing the parameters to the ErrorDocuments middleware in your config/middleware.py file.

document()[source]

Render the error document

img(id)[source]

Serve Pylons’ stock images

style(id)[source]

Serve Pylons’ stock stylesheets

showformscripts controller

This file defines the ShowformscriptsController used to generate the JavaScript code in forms.

class debianmemberportfolio.controllers.showformscripts.ShowformscriptsController[source]

This controller is used to support data entry in showform.

It provides code for generating JavaScript as well as JSON responses for autocompletion of fields.

fetchdddata()[source]

This action fetches the data for a given mail address and returns them as JSON.

index()[source]

This action generates the helper script for the showform page.

template controller

This file contains the TemplateController used to render templates.

Library code

app_globals

The application’s Globals object

class debianmemberportfolio.lib.app_globals.Globals(config)[source]

Globals acts as a container for objects available throughout the life of the application

base

The base Controller API

Provides the BaseController class for subclassing.

debianmemberportfolio.lib.base.render(template_name, extra_vars=None, cache_key=None, cache_type=None, cache_expire=None)

Render a template with Mako

Accepts the cache options cache_key, cache_type, and cache_expire.

helpers

Helper functions

Consists of functions to typically be used within templates, but also available to Controllers. This module is available to templates as ‘h’.

Model

Model classes and model related utilities for the Debian Member Portfolio service.

dddatabuilder

This file contains code to build a representation of a person based on keyring data associated to a given email address.

debianmemberportfolio.model.dddatabuilder.build_data(email_address)[source]

Build a DD data structure from a given email address.

form

This file contains the form definitions used in the controllers.

class debianmemberportfolio.model.form.DDDataRequest(*args, **kw)[source]

Validation schema for DDData request.

Messages

badDictType:
The input must be dict-like (not a %(type)s: %(value)r)
badType:
The input must be a string (not a %(type)s: %(value)r)
empty:
Please enter a value
missingValue:
Missing value
noneType:
The input must be a string (not None)
notExpected:
The input field %(name)s was not expected.
class debianmemberportfolio.model.form.DeveloperData(*args, **kw)[source]

Validation schema for DeveloperData.

Messages

badDictType:
The input must be dict-like (not a %(type)s: %(value)r)
badType:
The input must be a string (not a %(type)s: %(value)r)
empty:
Please enter a value
missingValue:
Missing value
noneType:
The input must be a string (not None)
notExpected:
The input field %(name)s was not expected.

keyfinder

This module provides tools for finding PGP key information from a given keyring.

debianmemberportfolio.model.keyfinder.getFingerprintByEmail(email)[source]

Gets the fingerprints associated with the given email address if available.

debianmemberportfolio.model.keyfinder.getLoginByEmail(email)[source]

Gets the logins associated with the given email address if available.

debianmemberportfolio.model.keyfinder.getLoginByFingerprint(fpr)[source]

Gets the login associated with the given fingerprint if available.

debianmemberportfolio.model.keyfinder.getRealnameByEmail(email)[source]

Gets the real names associated with the given email address if available.

keyringanalyzer

This is a tool that analyzes GPG and PGP keyrings and stores the retrieved data in a file database. The tool was inspired by Debian qa’s carnivore.

debianmemberportfolio.model.keyringanalyzer.process_gpg_list_keys_line(line, fpr)[source]

Process a line of gpg –list-keys –with-colon output.

debianmemberportfolio.model.keyringanalyzer.process_keyrings()[source]

Process the keyrings and store the extracted data in an anydbm file.

urlbuilder