archivebox.core package

Subpackages

• archivebox.core.migrations package
  • Submodules
  • archivebox.core.migrations.0001_initial module
    • Migration
      • Migration.initial
      • Migration.dependencies
      • Migration.operations
  • Module contents

Submodules

archivebox.core.admin module

class archivebox.core.admin.ArchiveResultInline(parent_model, admin_site)

Bases: TabularInline

model

alias of ArchiveResult

property media

class archivebox.core.admin.TagInline(parent_model, admin_site)

Bases: TabularInline

model

alias of Snapshot_tags

property media

class archivebox.core.admin.AutocompleteTags

Bases: object

model

alias of Tag

search_fields = ['name']

name = 'tags'

class archivebox.core.admin.AutocompleteTagsAdminStub

Bases: object

name = 'admin'

class archivebox.core.admin.SnapshotActionForm(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, field_order=None, use_required_attribute=None, renderer=None)

Bases: ActionForm

base_fields = {'action': <django.forms.fields.ChoiceField object>, 'select_across': <django.forms.fields.BooleanField object>, 'tags': <django.forms.models.ModelMultipleChoiceField object>}

declared_fields = {'action': <django.forms.fields.ChoiceField object>, 'select_across': <django.forms.fields.BooleanField object>, 'tags': <django.forms.models.ModelMultipleChoiceField object>}

property media

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

class archivebox.core.admin.SnapshotAdmin(model, admin_site)

Bases: SearchResultsAdminMixin, ModelAdmin

list_display = ('added', 'title_str', 'files', 'size', 'url_str')

sort_fields = ('title_str', 'url_str', 'added', 'files')

readonly_fields = ('info', 'bookmarked', 'added', 'updated')

search_fields = ('id', 'url', 'timestamp', 'title', 'tags__name')

fields = ('timestamp', 'url', 'title', 'tags', 'info', 'bookmarked', 'added', 'updated')

list_filter = ('added', 'updated', 'tags', 'archiveresult__status')

ordering = ['-added']

actions = ['add_tags', 'remove_tags', 'update_titles', 'update_snapshots', 'resnapshot_snapshot', 'overwrite_snapshots', 'delete_snapshots']

autocomplete_fields = ['tags']

inlines = [<class 'archivebox.core.admin.ArchiveResultInline'>]

list_per_page = 40

action_form

alias of SnapshotActionForm

changelist_view(request, extra_context=None)

The ‘change list’ admin view for this model.

get_urls()

get_queryset(request)

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

tag_list(obj)

info(obj)

title_str(obj)

files(obj)

size(obj)

url_str(obj)

grid_view(request, extra_context=None)

update_snapshots(request, queryset)

update_titles(request, queryset)

resnapshot_snapshot(request, queryset)

overwrite_snapshots(request, queryset)

delete_snapshots(request, queryset)

add_tags(request, queryset)

remove_tags(request, queryset)

property media

class archivebox.core.admin.TagAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('slug', 'name', 'num_snapshots', 'snapshots', 'id')

sort_fields = ('id', 'name', 'slug')

readonly_fields = ('id', 'num_snapshots', 'snapshots')

search_fields = ('id', 'name', 'slug')

fields = ('id', 'num_snapshots', 'snapshots', 'name', 'slug')

actions = ['delete_selected']

ordering = ['-id']

num_snapshots(obj)

snapshots(obj)

property media

class archivebox.core.admin.ArchiveResultAdmin(model, admin_site)

Bases: ModelAdmin

list_display = ('id', 'start_ts', 'extractor', 'snapshot_str', 'tags_str', 'cmd_str', 'status', 'output_str')

sort_fields = ('start_ts', 'extractor', 'status')

readonly_fields = ('id', 'uuid', 'snapshot_str', 'tags_str')

search_fields = ('id', 'uuid', 'snapshot__url', 'extractor', 'output', 'cmd_version', 'cmd', 'snapshot__timestamp')

fields = ('id', 'uuid', 'snapshot_str', 'tags_str', 'snapshot', 'extractor', 'status', 'start_ts', 'end_ts', 'output', 'pwd', 'cmd', 'cmd_version')

autocomplete_fields = ['snapshot']

list_filter = ('status', 'extractor', 'start_ts', 'cmd_version')

ordering = ['-start_ts']

list_per_page = 40

snapshot_str(obj)

tags_str(obj)

cmd_str(obj)

output_str(obj)

property media

class archivebox.core.admin.ArchiveBoxAdmin(name='admin')

Bases: AdminSite

site_header = 'ArchiveBox'

index_title = 'Links'

site_title = 'Index'

get_urls()

add_view(request)

archivebox.core.apps module

class archivebox.core.apps.CoreConfig(app_name, app_module)

Bases: AppConfig

name = 'core'

default_auto_field = 'django.db.models.UUIDField'

ready()

Override this method in subclasses to run code when Django starts.

archivebox.core.settings module

class archivebox.core.settings.NoisyRequestsFilter(name='')

Bases: Filter

filter(record)

Determine if the specified record is to be logged.

Returns True if the record should be logged, or False otherwise. If deemed appropriate, the record may be modified in-place.

archivebox.core.tests module

archivebox.core.urls module

archivebox.core.views module

class archivebox.core.views.HomepageView(**kwargs)

Bases: View

get(request)

class archivebox.core.views.SnapshotView(**kwargs)

Bases: View

get(request, path)

class archivebox.core.views.PublicIndexView(**kwargs)

Bases: ListView

template_name = 'public_index.html'

model

alias of Snapshot

paginate_by = 40

ordering = ['-added']

get_context_data(**kwargs)

Get the context for this view.

get_queryset(**kwargs)

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

get(*args, **kwargs)

class archivebox.core.views.AddView(**kwargs)

Bases: UserPassesTestMixin, FormView

template_name = 'add.html'

form_class

alias of AddLinkForm

get_initial()

Prefill the AddLinkForm with the ‘url’ GET parameter

test_func()

get_context_data(**kwargs)

Insert the form into the context dict.

form_valid(form)

If the form is valid, redirect to the supplied URL.

dispatch(request, *args, **kwargs)

class archivebox.core.views.HealthCheckView(**kwargs)

Bases: View

A Django view that renders plain text “OK” for service discovery tools

get(request)

Handle a GET request

archivebox.core.welcome_message module

archivebox.core.wsgi module

WSGI config for archivebox project.

It exposes the WSGI callable as a module-level variable named application.

For more information on this file, see https://docs.djangoproject.com/en/2.1/howto/deployment/wsgi/

Module contents