api package#

Submodules#

api.views module#

class api.views.APIHomeView(**kwargs)#

Bases: View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.LanguagesView(**kwargs)#

Bases: SerializeListView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ModuleBranchView(**kwargs)#

Bases: SerializeObjectView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ModuleLangStatsView(**kwargs)#

Bases: VertimusPageMixin, View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ModuleView(**kwargs)#

Bases: SerializeObjectView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

property fields#

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

class api.views.ModulesView(**kwargs)#

Bases: SerializeListView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ReleaseLanguageView(**kwargs)#

Bases: View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ReleaseStatsView(**kwargs)#

Bases: SerializeObjectView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ReleaseView(**kwargs)#

Bases: SerializeObjectView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ReleasesView(**kwargs)#

Bases: SerializeListView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.ReserveTranslationView(**kwargs)#

Bases: LoginRequiredMixin, VertimusPageMixin, View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.SerializeListView(**kwargs)#

Bases: View, ABC

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.SerializeObjectView(**kwargs)#

Bases: View, ABC

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.TeamView(**kwargs)#

Bases: SerializeObjectView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

property fields#

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

class api.views.TeamsView(**kwargs)#

Bases: SerializeListView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.UploadTranslationView(**kwargs)#

Bases: LoginRequiredMixin, VertimusPageMixin, View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

class api.views.VertimusPageMixin#

Bases: object

Mixin to be used in conjunction with a View. This is the default of any API view to manage the Vertimus workflow.

api.views.refresh_module_branch(request, module_name: str, branch_name: str)#

Refresh the statistics of a given module branch. This is intended to be called externally when the branch of this module has been updated, for instance a new commit has been added.

Note

CSRF is skipped, verification using a secret token given in HTTP_AUTHENTICATION

Parameters:
  • request – Django request.

  • module_name – the module name, ie gnome-hello

  • branch_name – the module branch, ie main, trunk

Module contents#