gpf_instance package

Subpackages

• gpf_instance.tests package
  • Submodules
  • gpf_instance.tests.test_version_api module
  • gpf_instance.tests.test_wgpf_instance module
  • Module contents

Submodules

gpf_instance.apps module

Provides class for configuing WDAE Django application.

class gpf_instance.apps.WDAEConfig(app_name, app_module)

Bases: AppConfig

Configure WDAE django application.

static load_extensions(gpf_instance: WGPFInstance) → None

Load WDAE GPF instance extensions.

name = 'gpf_instance'

ready() → None

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

gpf_instance.gpf_instance module

Provides wdae GPFInstance class.

gpf_instance.gpf_instance.get_wgpf_instance(config_filename: str | Path | None = None, **kwargs: Any) → WGPFInstance

Load and return a WGPFInstance.

gpf_instance.urls module

gpf_instance.views module

class gpf_instance.views.AboutDescriptionView

Bases: MarkdownFileView

Provide fetching and editing the main application description.

CONTENT_ID = 'instance_about'

get(_request: Request) → Response

Collect the application description.

class gpf_instance.views.DescriptionView

Bases: MarkdownFileView

Provide fetching and editing the main application description.

CONTENT_ID = 'instance_description'

get(_request: Request) → Response

Collect the application description.

class gpf_instance.views.MarkdownFileView

Bases: QueryBaseView

Provide fetching and editing markdown files.

CONTENT_ID = 'placeholder_id'

get(_request: Request) → Response

Collect the application description.

post(request: Request) → Response

Overwrite the application description.

gpf_instance.views.get_about_etag(_request: Request, **_kwargs: dict[str, Any]) → str | None

gpf_instance.views.get_description_etag(_request: Request, **_kwargs: dict[str, Any]) → str | None

gpf_instance.views.version(request, *args, **kwargs)

Get GPF version.

Module contents