beat.web.libraries.api module

class beat.web.libraries.api.CheckLibraryNameView(**kwargs)

Bases: beat.web.common.api.CheckContributionNameView

This view sanitizes a library name and checks whether it is already used.

model

alias of beat.web.libraries.models.Library

class beat.web.libraries.api.ShareLibraryView(**kwargs)

Bases: beat.web.code.api.ShareCodeView

This view allows to share a library with other users and/or teams

model

alias of beat.web.libraries.models.Library

class beat.web.libraries.api.ListLibrariesView(**kwargs)

Bases: beat.web.common.api.ListContributionView

List all available libraries

model

alias of beat.web.libraries.models.Library

serializer_class

alias of beat.web.libraries.serializers.LibrarySerializer

class beat.web.libraries.api.ListCreateLibrariesView(**kwargs)

Bases: beat.web.common.api.ListCreateContributionView

Read/Write end point that list the libraries available from a given author and allows the creation of new libraries

model

alias of beat.web.libraries.models.Library

serializer_class

alias of beat.web.libraries.serializers.LibrarySerializer

writing_serializer_class

alias of beat.web.libraries.serializers.LibraryCreationSerializer

namespace = 'api_libraries'

class beat.web.libraries.api.RetrieveUpdateDestroyLibrariesView(**kwargs)

Bases: beat.web.code.api.RetrieveUpdateDestroyCodeView

Read/Write/Delete endpoint for a given library

model

alias of beat.web.libraries.models.Library

serializer_class

alias of beat.web.libraries.serializers.FullLibrarySerializer

writing_serializer_class

alias of beat.web.libraries.serializers.LibraryModSerializer

class beat.web.libraries.api.DiffLibraryView(**kwargs)

Bases: beat.web.code.api.DiffView

This view shows the differences between two libraries

model

alias of beat.web.libraries.models.Library

serializer_class

alias of beat.web.code.serializers.CodeDiffSerializer