Developers Information

Sample configuration

The configuration will be taken from the default configuration file: ~/.config/swh/web/web.yml. The following introduces a default configuration file:

storage:
    cls: remote
    args:
        url: http://localhost:5002
debug: false
throttling:
    cache_uri: null
    scopes:
        swh_api:
            limiter_rate:
                default: 120/h
            exempted_networks:
                - 127.0.0.0/8

Run server

Either use the django manage script directly (useful in development mode as it offers various commands):

$ python3 -m swh.web.manage runserver

or use the following shortcut:

$ make run

Modules description

Common to all web applications

Configuration and settings

• swh.web.config: holds the configuration for the web applications. when building the documentation.

• swh.web.manage: Django management module for developers.

• swh.web.urls: module that holds the whole URI scheme of all the web applications.

• swh.web.settings.common: Common Django settings

• swh.web.settings.development: Django settings for development

• swh.web.settings.production: Django settings for production

• swh.web.settings.tests: Django settings for tests

Common utilities

• swh.web.utils.converters: conversion module used to transform raw data to serializable ones. It is used by swh.web.utils.archive: to convert data before transmitting then to Django views.

• swh.web.utils.exc: module defining exceptions used in the web applications.

• swh.web.utils.highlightjs: utility module to ease the use of the highlightjs library in produced Django views.

• swh.web.utils.query: Utilities to parse data from HTTP endpoints. It is used by swh.web.utils.archive.

• swh.web.utils.archive: Orchestration layer used by views module in charge of communication with swh.storage to retrieve information and perform conversion for the upper layer.

• swh.web.utils.swh_templatetags: Custom Django template tags library for swh.

• swh.web.utils.urlsindex: Utilities to help the registering of endpoints for the web applications

• swh.web.utils: Utility functions used in the web applications implementation

swh-web API application

• swh.web.api.apidoc: Utilities to document the web api for its html browsable rendering.

• swh.web.api.apiresponse: Utility module to ease the generation of web api responses.

• swh.web.api.apiurls: Utilities to facilitate the registration of web api endpoints.

• swh.web.api.throttling: Custom request rate limiter to use with the Django REST Framework

• swh.web.api.urls: Module that defines the whole URI scheme for the api endpoints

• swh.web.api.utils: Utility functions used in the web api implementation.

• swh.web.api.views.content: Implementation of API endpoints for getting information about contents.

• swh.web.api.views.directory: Implementation of API endpoints for getting information about directories.

• swh.web.api.views.origin: Implementation of API endpoints for getting information about origins.

• swh.web.api.views.person: Implementation of API endpoints for getting information about persons.

• swh.web.api.views.release: Implementation of API endpoints for getting information about releases.

• swh.web.api.views.revision: Implementation of API endpoints for getting information about revisions.

• swh.web.api.views.snapshot: Implementation of API endpoints for getting information about snapshots.

• swh.web.api.views.stat: Implementation of API endpoints for getting information about archive statistics.

• swh.web.api.views.utils: Utilities used in the web api endpoints implementation.

swh-web browse application

• swh.web.browse.browseurls: Utilities to facilitate the registration of browse endpoints.

• swh.web.browse.urls: Module that defines the whole URI scheme for the browse endpoints.

• swh.web.browse.utils: Utilities functions used throughout the browse endpoints implementation.

• swh.web.browse.views.content: Implementation of endpoints for browsing contents.

• swh.web.browse.views.directory: Implementation of endpoints for browsing directories.

• swh.web.browse.views.identifiers: Implementation of endpoints for browsing objects through SoftWare Heritage persistent IDentifiers (SWHIDs).

• swh.web.browse.views.origin: Implementation of endpoints for browsing origins.

• swh.web.browse.views.person: Implementation of endpoints for browsing persons.

• swh.web.browse.views.release: Implementation of endpoints for browsing releases.

• swh.web.browse.views.revision: Implementation of endpoints for browsing revisions.

• swh.web.browse.views.snapshot: Implementation of endpoints for browsing snapshots.