akvo.rsr.admin module

Akvo RSR is covered by the GNU Affero General Public License.

See more details in the license.txt file located at the root folder of the Akvo RSR module. For additional details on the GNU license please see < http://www.gnu.org/licenses/agpl.html >.

class akvo.rsr.admin.ApiKeyInline(parent_model, admin_site)

Bases: StackedInline

fields = ('key',)

has_delete_permission(request, obj=None, **kwargs)

Return True if the given request has permission to delete the given Django model instance, the default implementation doesn’t examine the obj parameter.

Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to delete the obj model instance. If obj is None, this should return True if the given request has permission to delete any object of the given type.

property media

model

alias of ApiKey

readonly_fields = ('key',)

class akvo.rsr.admin.BudgetItemLabelAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('label',)

property media

class akvo.rsr.admin.CountryAdmin(model, admin_site)

Bases: ModelAdmin

get_readonly_fields(request, obj=None)

Hook for specifying custom readonly fields.

list_display = ('name', 'iso_code', 'continent', 'continent_code')

list_filter = ('continent',)

property media

readonly_fields = ('name', 'continent', 'continent_code')

save_model(request, obj, form, change)

Given a model instance save it to the database.

class akvo.rsr.admin.EmploymentAdmin(model, admin_site)

Bases: ModelAdmin

formfield_for_foreignkey(db_field, request=None, **kwargs)

Get a form Field for a ForeignKey.

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

list_display = ('__str__', 'user', 'organisation', 'group', 'is_approved', 'iati_country', 'job_title')

list_filter = ('is_approved', 'organisation')

property media

model

alias of Employment

search_fields = ('organisation__name', 'organisation__long_name', 'user__username')

class akvo.rsr.admin.IatiActivityExportInline(parent_model, admin_site)

Bases: TabularInline

extra = 0

fields = ('project', 'status', 'created_at')

fk_name = 'iati_export'

property media

model

alias of IatiActivityExport

readonly_fields = ('project', 'status', 'created_at')

class akvo.rsr.admin.IatiExportAdmin(model, admin_site)

Bases: ModelAdmin

exclude = ('projects',)

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

inlines = (<class 'akvo.rsr.admin.IatiActivityExportInline'>,)

list_display = ('__str__', 'reporting_organisation', 'user', 'version', 'iati_file', 'show_status', 'latest')

property media

model

alias of IatiExport

class akvo.rsr.admin.IndicatorCustomFieldInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('name', 'type', 'order', 'mandatory', 'dropdown_options')

fk_name = 'project'

formfield_overrides = {<class 'django.db.models.fields.json.JSONField'>: {'widget': <class 'prettyjson.widgets.PrettyJSONWidget'>}}

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of IndicatorCustomField

class akvo.rsr.admin.IndicatorPeriodAggregationJobAdmin(model, admin_site)

Bases: ModelAdmin

get_project(period)

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

indicator_title(obj)

list_display = ('indicator_title', 'status', 'project_title', 'root_project_title', 'period', 'updated_at')

list_filter = ('status',)

property media

model

alias of IndicatorPeriodAggregationJob

project_title(obj)

readonly_fields = ('updated_at', 'period', 'root_period', 'project_title', 'root_project_title', 'indicator_title')

root_project_title(obj)

search_fields = ('period__indicator__result__period__title', 'period__indicator__title')

class akvo.rsr.admin.IndicatorPeriodDataAdmin(model, admin_site)

Bases: ModelAdmin

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

inlines = (<class 'akvo.rsr.admin.IndicatorPeriodDataCommentInline'>,)

list_display = ('period', 'user', 'value', 'status')

property media

model

alias of IndicatorPeriodData

readonly_fields = ('created_at', 'last_modified_at')

class akvo.rsr.admin.IndicatorPeriodDataCommentInline(parent_model, admin_site)

Bases: TabularInline

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of IndicatorPeriodDataComment

class akvo.rsr.admin.InternalOrganisationIDAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('identifier', 'recording_org', 'referenced_org')

property media

search_fields = ('identifier', 'recording_org__name', 'referenced_org__name')

class akvo.rsr.admin.KeywordAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('label', 'logo')

property media

model

alias of Keyword

class akvo.rsr.admin.NarrativeReportAdmin(model, admin_site)

Bases: ModelAdmin

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

list_display = ('project', 'category', 'published')

property media

class akvo.rsr.admin.OrganisationAccountAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('organisation', 'account_level')

property media

class akvo.rsr.admin.OrganisationAdmin(model, admin_site)

Bases: TimestampsAdminDisplayMixin, ObjectPermissionsModelAdmin, NestedModelAdmin

OrganisationAdmin.

NOTE: The change_form.html template relies on the fieldsets to put the inline forms correctly. If the fieldsets are changed, the template may need fixing too

add_view(request, form_url='', extra_context=None)

The ‘add’ admin view for this model.

exclude = ('internal_org_ids',)

fieldsets = (('General information', {'fields': ('name', 'long_name', 'iati_org_id', 'description', 'new_organisation_type', 'logo', 'language', 'currency', 'iati_prefixes', 'password_policy', 'enforce_2fa')}), ('Contact information', {'fields': ('url', 'facebook', 'twitter', 'linkedin', 'phone', 'mobile', 'fax', 'contact_person', 'contact_email')}), ('Organisation settings', {'fields': ('can_create_projects', 'enforce_program_projects', 'public_iati_file', 'content_owner', 'codelist')}), ('Notes', {'fields': ('notes',)}))

form

alias of OrganisationAdminForm

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

get_readonly_fields(request, obj=None)

Make sure only super users can set the ability to become a reporting org

inlines = (<class 'akvo.rsr.admin.OrganisationLocationInline'>, <class 'akvo.rsr.admin.OrganisationTotalBudgetInline'>, <class 'akvo.rsr.admin.OrganisationRecipientOrgBudgetInline'>, <class 'akvo.rsr.admin.OrganisationRegionBudgetInline'>, <class 'akvo.rsr.admin.OrganisationCountryBudgetInline'>, <class 'akvo.rsr.admin.OrganisationTotalExpenditureInline'>, <class 'akvo.rsr.admin.OrganisationDocumentInline'>, <class 'akvo.rsr.admin.OrganisationCustomFieldInline'>, <class 'akvo.rsr.admin.OrganisationIndicatorLabelInline'>)

list_display = ('name', 'long_name', 'website', 'language')

property media

save_model(request, obj, form, change)

Given a model instance save it to the database.

search_fields = ('name', 'long_name')

class akvo.rsr.admin.OrganisationAdminForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)

Bases: ModelForm

base_fields = {}

clean_iati_org_id()

declared_fields = {}

property media

Return all media required to render the widgets on this form.

class akvo.rsr.admin.OrganisationCodeList(model, admin_site)

Bases: ModelAdmin

formfield_overrides = {<class 'django.db.models.fields.json.JSONField'>: {'widget': <class 'prettyjson.widgets.PrettyJSONWidget'>}}

list_display = ('slug',)

property media

class akvo.rsr.admin.OrganisationCountryBudgetInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('country', 'text', 'currency', 'value', 'value_date', 'period_start', 'period_end', 'status')

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

inlines = (<class 'akvo.rsr.admin.OrganisationCountryBudgetLineInline'>,)

property media

model

alias of OrganisationCountryBudget

class akvo.rsr.admin.OrganisationCountryBudgetLineInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'reference', 'text')

fk_name = 'budget'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationCountryBudgetLine

class akvo.rsr.admin.OrganisationCustomFieldInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('name', 'type', 'section', 'order', 'max_characters', 'mandatory', 'help_text', 'dropdown_options', 'show_in_searchbar')

fk_name = 'organisation'

formfield_overrides = {<class 'django.db.models.fields.json.JSONField'>: {'widget': <class 'prettyjson.widgets.PrettyJSONWidget'>}}

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationCustomField

class akvo.rsr.admin.OrganisationDocumentCategoryInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('category',)

fk_name = 'document'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationDocumentCategory

class akvo.rsr.admin.OrganisationDocumentCountryInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('country', 'text')

fk_name = 'document'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationDocumentCountry

class akvo.rsr.admin.OrganisationDocumentInline(parent_model, admin_site)

Bases: NestedStackedInline

fields = ('url', 'document', 'format', 'title', 'title_language', 'language', 'document_date')

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

inlines = (<class 'akvo.rsr.admin.OrganisationDocumentCategoryInline'>, <class 'akvo.rsr.admin.OrganisationDocumentCountryInline'>)

property media

model

alias of OrganisationDocument

class akvo.rsr.admin.OrganisationIndicatorLabelInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('label',)

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationIndicatorLabel

class akvo.rsr.admin.OrganisationLocationInline(parent_model, admin_site)

Bases: NestedStackedInline

fields = ('latitude', 'longitude', 'city', 'state', 'address_1', 'address_2', 'postcode', 'iati_country')

fk_name = 'location_target'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationLocation

class akvo.rsr.admin.OrganisationRecipientOrgBudgetInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('recipient_organisation', 'currency', 'value', 'value_date', 'period_start', 'period_end', 'status')

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

inlines = (<class 'akvo.rsr.admin.OrganisationRecipientOrgBudgetLineInline'>,)

property media

model

alias of OrganisationRecipientOrgBudget

class akvo.rsr.admin.OrganisationRecipientOrgBudgetLineInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'reference', 'text')

fk_name = 'budget'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationRecipientOrgBudgetLine

class akvo.rsr.admin.OrganisationRegionBudgetInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('region', 'region_vocabulary', 'region_vocabulary_uri', 'text', 'currency', 'value', 'value_date', 'period_start', 'period_end', 'status')

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

inlines = (<class 'akvo.rsr.admin.OrganisationRegionBudgetLineInline'>,)

property media

model

alias of OrganisationRegionBudget

class akvo.rsr.admin.OrganisationRegionBudgetLineInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'reference', 'text')

fk_name = 'budget'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationRegionBudgetLine

class akvo.rsr.admin.OrganisationTotalBudgetInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'period_start', 'period_end', 'status')

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

inlines = (<class 'akvo.rsr.admin.OrganisationTotalBudgetLineInline'>,)

property media

model

alias of OrganisationTotalBudget

class akvo.rsr.admin.OrganisationTotalBudgetLineInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'reference', 'text')

fk_name = 'budget'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationTotalBudgetLine

class akvo.rsr.admin.OrganisationTotalExpenditureInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'period_start', 'period_end')

fk_name = 'organisation'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

inlines = (<class 'akvo.rsr.admin.OrganisationTotalExpenditureLineInline'>,)

property media

model

alias of OrganisationTotalExpenditure

class akvo.rsr.admin.OrganisationTotalExpenditureLineInline(parent_model, admin_site)

Bases: NestedTabularInline

fields = ('currency', 'value', 'value_date', 'reference', 'text')

fk_name = 'expenditure'

get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

property media

model

alias of OrganisationExpenseLine

class akvo.rsr.admin.PartnerSiteAdmin(model, admin_site)

Bases: TimestampsAdminDisplayMixin, ModelAdmin

Defines the RSR Pages admin.

exclude = ('about_box', 'about_image')

fieldsets = (('General', {'fields': ('organisation', 'tagline', 'enabled', 'password')}), ('Program selection', {'fields': ('program',)}), ('Project selection', {'description': '<p style="margin-left:0; padding-left:0; margin-top:1em; width:75%%;">Select the projects to be shown on your Site.</p><p style="margin-left:0; padding-left:0; margin-top:1em; width:75%%;">The default setting selects all projects associated with the organisation of the Site.</p><p style="margin-left:0; padding-left:0; margin-top:1em; width:75%%;">De-selecting the "Show only projects of partner" check-box shows all projects in RSR. This is meant to be used with the keywords below, thus selecting only projects associated with the selected keywords. <br/>If keywords are added to a Site showing only projects of a partner, the selection will be further filtered by only showing associated projects with those keywords.</p><p style="margin-left:0; padding-left:0; margin-top:1em; width:75%%;">When "Exclude projects with selected keyword is checked" projects with the chosen keywords are instead excluded from the list.</p>', 'fields': ('partner_projects', 'exclude_keywords', 'keywords')}), ('HTTP', {'fields': ('hostname', ('cname', 'redirect_cname'), 'custom_return_url', 'custom_return_url_text', 'piwik_id')}), ('Style and content', {'fields': ('all_maps', 'custom_css', 'custom_logo', 'custom_map_marker', 'custom_favicon', 'show_keyword_logos')}), ('Languages and translation', {'fields': ('google_translation',)}), ('Social', {'fields': ('twitter_button', 'facebook_button', 'facebook_app_id')}))

filter_horizontal = ('keywords',)

get_fieldsets(request, obj=None)

Don’t show the notes field unless you are superuser or admin.

# note that this is somewhat fragile as it relies on adding/removing from the _first_ # fieldset

get_form(request, obj=None, **kwargs)

Workaround bug http://code.djangoproject.com/ticket/9360.

get_list_display(request)

“See the notes fields in the change list if you are superuser or admin.

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

list_display = ('__str__', 'full_domain', 'enabled', 'show_keywords')

list_filter = ('enabled', 'keywords')

property media

readonly_fields = ('created_at', 'last_modified_at')

class akvo.rsr.admin.ProgramAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('root_project', 'organisation', 'is_master', 'max_depth')

property media

model

alias of ProjectHierarchy

class akvo.rsr.admin.ProjectAdmin(model, admin_site)

Bases: TimestampsAdminDisplayMixin, ObjectPermissionsModelAdmin, NestedModelAdmin

fieldsets = (('General Information', {'description': '<p style="margin-left:0; padding-left:0; margin-top:1em; width:75%;">This section should contain the top-level information about your project which will be publicly available and used within searches. Try to keep your Title and Subtitle short and snappy.</p>', 'fields': ('title', 'subtitle', 'iati_activity_id', 'iati_status', 'currency', 'is_public')}),)

filter_horizontal = ('keywords',)

get_limited_queryset(request)

Queryset filtered on connected organisation and only for Admin and Project Editors.

get_limited_queryset_slq_style(request)

Slower than the non sql alternative, might be able to make it fast somehow.

get_queryset(request)

If superuser or admin return full queryset, otherwise return limited queryset.

inlines = (<class 'akvo.rsr.admin.IndicatorCustomFieldInline'>,)

list_display = ('id', 'title', 'status', 'is_published', 'show_keywords')

list_filter = ('currency', 'status', 'keywords')

property media

model

alias of Project

readonly_fields = ('title', 'subtitle', 'iati_activity_id', 'iati_status', 'currency', 'is_public', 'created_at', 'last_modified_at')

search_fields = ('id', 'title', 'subtitle')

class akvo.rsr.admin.ProjectUpdateAdmin(model, admin_site)

Bases: TimestampsAdminDisplayMixin, AdminVideoMixin, ModelAdmin

fieldsets = (('General Information', {'fields': ('project', 'user', 'update_method', 'created_at', 'last_modified_at')}), ('Content', {'fields': ('title', 'text', 'language', 'event_date')}), ('Image and video', {'fields': ('photo', 'photo_caption', 'photo_credit', 'video', 'video_caption', 'video_credit')}))

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

inlines = (<class 'akvo.rsr.admin.ProjectUpdateLocationInline'>,)

list_display = ('title', 'project', 'user', 'text', 'language', 'event_date', 'created_at', 'img')

list_filter = ('created_at', 'project')

property media

readonly_fields = ('created_at', 'last_modified_at')

search_fields = ('title', 'id', 'project__id', 'project__title', 'user__first_name', 'user__last_name')

class akvo.rsr.admin.ProjectUpdateLocationInline(parent_model, admin_site)

Bases: StackedInline

extra = 0

fields = ('latitude', 'longitude', 'city', 'state', 'address_1', 'address_2', 'postcode')

property media

model

alias of ProjectUpdateLocation

class akvo.rsr.admin.ReportAdmin(model, admin_site)

Bases: ModelAdmin

filter_horizontal = ('organisations',)

form

alias of ReportAdminForm

property media

model

alias of Report

save_as = True

class akvo.rsr.admin.ReportAdminForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)

Bases: ModelForm

class Meta

Bases: object

fields = ('name', 'title', 'description', 'url', 'formats', 'organisations')

model

alias of Report

widgets = {'url': <django.forms.widgets.Textarea object>}

base_fields = {'description': <django.forms.fields.CharField object>, 'formats': <django.forms.models.ModelMultipleChoiceField object>, 'name': <django.forms.fields.CharField object>, 'organisations': <django.forms.models.ModelMultipleChoiceField object>, 'title': <django.forms.fields.CharField object>, 'url': <django.forms.fields.CharField object>}

declared_fields = {}

property media

Return all media required to render the widgets on this form.

class akvo.rsr.admin.ReportFormatAdmin(model, admin_site)

Bases: ModelAdmin

property media

model

alias of ReportFormat

class akvo.rsr.admin.UserAdmin(model, admin_site)

Bases: UserAdmin

add_fieldsets = ((None, {'classes': ('wide',), 'fields': ('username', 'email', 'password1', 'password2')}),)

add_form

alias of UserCreationForm

fieldsets = ((None, {'fields': ('username', 'email', 'password')}), ('Personal info', {'fields': ('first_name', 'last_name')}), ('Permissions', {'fields': ('is_active', 'is_staff', 'is_admin', 'is_support', 'is_superuser', 'enforce_2fa')}), ('Important dates', {'fields': ('last_login', 'date_joined')}))

form

alias of UserChangeForm

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

get_readonly_fields(request, obj=None)

Hook for specifying custom readonly fields.

inlines = (<class 'akvo.rsr.admin.ApiKeyInline'>,)

list_display = ('username', 'email', 'get_organisation_names', 'get_full_name', 'is_active', 'is_admin', 'is_support', 'latest_update_date')

property media

model

alias of User

ordering = ('username',)

search_fields = ('username', 'email', 'first_name', 'last_name')

class akvo.rsr.admin.UserChangeForm(*args, **kwargs)

Bases: UserChangeForm

base_fields = {'date_joined': <django.forms.fields.DateTimeField object>, 'email': <django.forms.fields.EmailField object>, 'first_name': <django.forms.fields.CharField object>, 'groups': <django.forms.models.ModelMultipleChoiceField object>, 'is_active': <django.forms.fields.BooleanField object>, 'is_staff': <django.forms.fields.BooleanField object>, 'is_superuser': <django.forms.fields.BooleanField object>, 'last_login': <django.forms.fields.DateTimeField object>, 'last_name': <django.forms.fields.CharField object>, 'password': <django.contrib.auth.forms.ReadOnlyPasswordHashField object>, 'user_permissions': <django.forms.models.ModelMultipleChoiceField object>, 'username': <django.forms.fields.RegexField object>}

declared_fields = {'password': <django.contrib.auth.forms.ReadOnlyPasswordHashField object>, 'username': <django.forms.fields.RegexField object>}

property media

Return all media required to render the widgets on this form.

class akvo.rsr.admin.UserCreationForm(*args, **kwargs)

Bases: UserCreationForm

base_fields = {'password1': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'username': <django.forms.fields.RegexField object>}

declared_fields = {'password1': <django.forms.fields.CharField object>, 'password2': <django.forms.fields.CharField object>, 'username': <django.forms.fields.RegexField object>}

property media

Return all media required to render the widgets on this form.

class akvo.rsr.admin.ValidationSetAdmin(model, admin_site)

Bases: ModelAdmin

fields = ('name', 'description')

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

list_display = ('name', 'description')

property media

model

alias of ProjectEditorValidationSet