catalog.api package#
Concepts#
Subpackages#
- catalog.api.constants package
- catalog.api.controllers package
- catalog.api.docs package
- catalog.api.examples package
- catalog.api.models package- Submodules
- catalog.api.models.audio module- AltAudioFile
- Audio- Audio.DoesNotExist
- Audio.MultipleObjectsReturned
- Audio.alt_files
- Audio.alternative_files
- Audio.audio_report
- Audio.audio_set
- Audio.audio_set_foreign_identifier
- Audio.audio_set_position
- Audio.audioset
- Audio.bit_rate
- Audio.category
- Audio.created_on
- Audio.creator
- Audio.creator_url
- Audio.deleted_audio
- Audio.duration
- Audio.duration_in_s
- Audio.filesize
- Audio.filetype
- Audio.foreign_identifier
- Audio.foreign_landing_url
- Audio.genres
- Audio.get_next_by_created_on()
- Audio.get_next_by_updated_on()
- Audio.get_or_create_waveform()
- Audio.get_previous_by_created_on()
- Audio.get_previous_by_updated_on()
- Audio.get_waveform()
- Audio.id
- Audio.identifier
- Audio.last_synced_with_source
- Audio.license
- Audio.license_version
- Audio.lists
- Audio.mature
- Audio.mature_audio
- Audio.meta_data
- Audio.objects
- Audio.provider
- Audio.removed_from_source
- Audio.sample_rate
- Audio.source
- Audio.tags
- Audio.tags_list
- Audio.thumbnail
- Audio.title
- Audio.updated_on
- Audio.url
- Audio.view_count
- Audio.watermarked
 
- AudioAddOn- AudioAddOn.DoesNotExist
- AudioAddOn.MultipleObjectsReturned
- AudioAddOn.audio_identifier
- AudioAddOn.created_on
- AudioAddOn.get_next_by_created_on()
- AudioAddOn.get_next_by_updated_on()
- AudioAddOn.get_previous_by_created_on()
- AudioAddOn.get_previous_by_updated_on()
- AudioAddOn.objects
- AudioAddOn.updated_on
- AudioAddOn.waveform_peaks
 
- AudioFileMixin
- AudioList- AudioList.DoesNotExist
- AudioList.MultipleObjectsReturned
- AudioList.audios
- AudioList.auth
- AudioList.created_on
- AudioList.get_next_by_created_on()
- AudioList.get_next_by_updated_on()
- AudioList.get_previous_by_created_on()
- AudioList.get_previous_by_updated_on()
- AudioList.id
- AudioList.objects
- AudioList.save()
- AudioList.slug
- AudioList.title
- AudioList.updated_on
 
- AudioReport- AudioReport.DoesNotExist
- AudioReport.MultipleObjectsReturned
- AudioReport.audio_url
- AudioReport.created_at
- AudioReport.deleted_class
- AudioReport.description
- AudioReport.get_next_by_created_at()
- AudioReport.get_previous_by_created_at()
- AudioReport.get_reason_display()
- AudioReport.get_status_display()
- AudioReport.id
- AudioReport.mature_class
- AudioReport.media_class
- AudioReport.media_obj
- AudioReport.media_obj_id
- AudioReport.objects
- AudioReport.reason
- AudioReport.status
 
- AudioSet- AudioSet.DoesNotExist
- AudioSet.MultipleObjectsReturned
- AudioSet.audio_set
- AudioSet.created_on
- AudioSet.creator
- AudioSet.creator_url
- AudioSet.filesize
- AudioSet.filetype
- AudioSet.foreign_identifier
- AudioSet.foreign_landing_url
- AudioSet.get_next_by_created_on()
- AudioSet.get_next_by_updated_on()
- AudioSet.get_previous_by_created_on()
- AudioSet.get_previous_by_updated_on()
- AudioSet.id
- AudioSet.identifier
- AudioSet.objects
- AudioSet.provider
- AudioSet.thumbnail
- AudioSet.title
- AudioSet.tracks
- AudioSet.updated_on
- AudioSet.url
 
- DeletedAudio- DeletedAudio.DoesNotExist
- DeletedAudio.MultipleObjectsReturned
- DeletedAudio.created_on
- DeletedAudio.es_index
- DeletedAudio.get_next_by_created_on()
- DeletedAudio.get_next_by_updated_on()
- DeletedAudio.get_previous_by_created_on()
- DeletedAudio.get_previous_by_updated_on()
- DeletedAudio.media_class
- DeletedAudio.media_obj
- DeletedAudio.media_obj_id
- DeletedAudio.objects
- DeletedAudio.updated_on
 
- MatureAudio
 
- catalog.api.models.base module
- catalog.api.models.image module- DeletedImage- DeletedImage.DoesNotExist
- DeletedImage.MultipleObjectsReturned
- DeletedImage.created_on
- DeletedImage.es_index
- DeletedImage.get_next_by_created_on()
- DeletedImage.get_next_by_updated_on()
- DeletedImage.get_previous_by_created_on()
- DeletedImage.get_previous_by_updated_on()
- DeletedImage.media_class
- DeletedImage.media_obj
- DeletedImage.media_obj_id
- DeletedImage.objects
- DeletedImage.updated_on
 
- Image- Image.DoesNotExist
- Image.MultipleObjectsReturned
- Image.category
- Image.created_on
- Image.creator
- Image.creator_url
- Image.deleted_image
- Image.filesize
- Image.filetype
- Image.foreign_identifier
- Image.foreign_landing_url
- Image.get_next_by_created_on()
- Image.get_next_by_updated_on()
- Image.get_previous_by_created_on()
- Image.get_previous_by_updated_on()
- Image.height
- Image.id
- Image.identifier
- Image.image_report
- Image.last_synced_with_source
- Image.license
- Image.license_version
- Image.lists
- Image.mature
- Image.mature_image
- Image.meta_data
- Image.objects
- Image.provider
- Image.removed_from_source
- Image.source
- Image.tags
- Image.tags_list
- Image.thumbnail
- Image.title
- Image.updated_on
- Image.url
- Image.view_count
- Image.watermarked
- Image.width
 
- ImageFileMixin
- ImageList- ImageList.DoesNotExist
- ImageList.MultipleObjectsReturned
- ImageList.auth
- ImageList.created_on
- ImageList.get_next_by_created_on()
- ImageList.get_next_by_updated_on()
- ImageList.get_previous_by_created_on()
- ImageList.get_previous_by_updated_on()
- ImageList.id
- ImageList.images
- ImageList.objects
- ImageList.save()
- ImageList.slug
- ImageList.title
- ImageList.updated_on
 
- ImageReport- ImageReport.DoesNotExist
- ImageReport.MultipleObjectsReturned
- ImageReport.created_at
- ImageReport.deleted_class
- ImageReport.description
- ImageReport.get_next_by_created_at()
- ImageReport.get_previous_by_created_at()
- ImageReport.get_reason_display()
- ImageReport.get_status_display()
- ImageReport.id
- ImageReport.image_url
- ImageReport.mature_class
- ImageReport.media_class
- ImageReport.media_obj
- ImageReport.media_obj_id
- ImageReport.objects
- ImageReport.reason
- ImageReport.status
 
- MatureImage
 
- catalog.api.models.media module- AbstractAltFile
- AbstractDeletedMedia- AbstractDeletedMedia.Meta
- AbstractDeletedMedia.created_on
- AbstractDeletedMedia.es_index
- AbstractDeletedMedia.get_next_by_created_on()
- AbstractDeletedMedia.get_next_by_updated_on()
- AbstractDeletedMedia.get_previous_by_created_on()
- AbstractDeletedMedia.get_previous_by_updated_on()
- AbstractDeletedMedia.media_class
- AbstractDeletedMedia.media_obj
- AbstractDeletedMedia.media_obj_id
- AbstractDeletedMedia.save()
- AbstractDeletedMedia.updated_on
 
- AbstractMatureMedia- AbstractMatureMedia.Meta
- AbstractMatureMedia.created_on
- AbstractMatureMedia.delete()
- AbstractMatureMedia.es_index
- AbstractMatureMedia.get_next_by_created_on()
- AbstractMatureMedia.get_previous_by_created_on()
- AbstractMatureMedia.media_class
- AbstractMatureMedia.media_obj
- AbstractMatureMedia.media_obj_id
- AbstractMatureMedia.save()
 
- AbstractMedia- AbstractMedia.Meta
- AbstractMedia.attribution
- AbstractMedia.category
- AbstractMedia.created_on
- AbstractMedia.creator
- AbstractMedia.creator_url
- AbstractMedia.foreign_identifier
- AbstractMedia.foreign_landing_url
- AbstractMedia.get_next_by_created_on()
- AbstractMedia.get_next_by_updated_on()
- AbstractMedia.get_previous_by_created_on()
- AbstractMedia.get_previous_by_updated_on()
- AbstractMedia.identifier
- AbstractMedia.last_synced_with_source
- AbstractMedia.license
- AbstractMedia.license_url
- AbstractMedia.license_version
- AbstractMedia.meta_data
- AbstractMedia.provider
- AbstractMedia.removed_from_source
- AbstractMedia.source
- AbstractMedia.tags
- AbstractMedia.tags_list
- AbstractMedia.thumbnail
- AbstractMedia.title
- AbstractMedia.updated_on
- AbstractMedia.view_count
- AbstractMedia.watermarked
 
- AbstractMediaList- AbstractMediaList.Meta
- AbstractMediaList.auth
- AbstractMediaList.created_on
- AbstractMediaList.get_next_by_created_on()
- AbstractMediaList.get_next_by_updated_on()
- AbstractMediaList.get_previous_by_created_on()
- AbstractMediaList.get_previous_by_updated_on()
- AbstractMediaList.slug
- AbstractMediaList.title
- AbstractMediaList.updated_on
 
- AbstractMediaReport- AbstractMediaReport.BASE_URL
- AbstractMediaReport.Meta
- AbstractMediaReport.REPORT_CHOICES
- AbstractMediaReport.STATUS_CHOICES
- AbstractMediaReport.clean()
- AbstractMediaReport.created_at
- AbstractMediaReport.deleted_class
- AbstractMediaReport.description
- AbstractMediaReport.get_next_by_created_at()
- AbstractMediaReport.get_previous_by_created_at()
- AbstractMediaReport.get_reason_display()
- AbstractMediaReport.get_status_display()
- AbstractMediaReport.mature_class
- AbstractMediaReport.media_class
- AbstractMediaReport.media_obj
- AbstractMediaReport.media_obj_id
- AbstractMediaReport.reason
- AbstractMediaReport.save()
- AbstractMediaReport.status
- AbstractMediaReport.url()
 
 
- catalog.api.models.mixins module
- catalog.api.models.models module- ContentProvider- ContentProvider.DoesNotExist
- ContentProvider.MultipleObjectsReturned
- ContentProvider.created_on
- ContentProvider.domain_name
- ContentProvider.filter_content
- ContentProvider.get_media_type_display()
- ContentProvider.get_next_by_created_on()
- ContentProvider.get_previous_by_created_on()
- ContentProvider.id
- ContentProvider.media_type
- ContentProvider.notes
- ContentProvider.objects
- ContentProvider.provider_identifier
- ContentProvider.provider_name
 
- Tag
 
- catalog.api.models.oauth module- OAuth2Registration
- OAuth2Verification
- ThrottledApplication- ThrottledApplication.DoesNotExist
- ThrottledApplication.MultipleObjectsReturned
- ThrottledApplication.RATE_LIMIT_MODELS
- ThrottledApplication.accesstoken_set
- ThrottledApplication.algorithm
- ThrottledApplication.authorization_grant_type
- ThrottledApplication.client_id
- ThrottledApplication.client_secret
- ThrottledApplication.client_type
- ThrottledApplication.created
- ThrottledApplication.get_algorithm_display()
- ThrottledApplication.get_authorization_grant_type_display()
- ThrottledApplication.get_client_type_display()
- ThrottledApplication.get_next_by_created()
- ThrottledApplication.get_next_by_updated()
- ThrottledApplication.get_previous_by_created()
- ThrottledApplication.get_previous_by_updated()
- ThrottledApplication.get_rate_limit_model_display()
- ThrottledApplication.grant_set
- ThrottledApplication.id
- ThrottledApplication.idtoken_set
- ThrottledApplication.name
- ThrottledApplication.oauth2verification_set
- ThrottledApplication.objects
- ThrottledApplication.rate_limit_model
- ThrottledApplication.redirect_uris
- ThrottledApplication.refreshtoken_set
- ThrottledApplication.skip_authorization
- ThrottledApplication.updated
- ThrottledApplication.user
- ThrottledApplication.user_id
- ThrottledApplication.verified
 
 
- Module contents
 
- catalog.api.serializers package- Submodules
- catalog.api.serializers.audio_serializers module
- catalog.api.serializers.error_serializers module
- catalog.api.serializers.image_serializers module
- catalog.api.serializers.media_serializers module- MediaReportRequestSerializer
- MediaSearchRequestSerializer- MediaSearchRequestSerializer.DeprecatedParam
- MediaSearchRequestSerializer.deprecated_params
- MediaSearchRequestSerializer.fields_names
- MediaSearchRequestSerializer.needs_db
- MediaSearchRequestSerializer.validate()
- MediaSearchRequestSerializer.validate_creator()
- MediaSearchRequestSerializer.validate_extension()
- MediaSearchRequestSerializer.validate_license()
- MediaSearchRequestSerializer.validate_license_type()
- MediaSearchRequestSerializer.validate_page_size()
- MediaSearchRequestSerializer.validate_q()
- MediaSearchRequestSerializer.validate_tags()
- MediaSearchRequestSerializer.validate_title()
- MediaSearchRequestSerializer.validate_unstable__sort_by()
- MediaSearchRequestSerializer.validate_unstable__sort_dir()
 
- MediaSearchSerializer
- MediaSerializer
- MediaThumbnailRequestSerializer
- TagSerializer
- get_hyperlinks_serializer()
- get_search_request_source_serializer()
 
- catalog.api.serializers.oauth2_serializers module
- catalog.api.serializers.provider_serializers module
- Module contents
 
- catalog.api.utils package- Submodules
- catalog.api.utils.ccrel module
- catalog.api.utils.dead_link_mask module
- catalog.api.utils.exceptions module
- catalog.api.utils.oauth2_helper module
- catalog.api.utils.pagination module
- catalog.api.utils.scheduled_tasks module
- catalog.api.utils.status_code_view module
- catalog.api.utils.throttle module- AbstractAnonRateThrottle
- AbstractOAuth2IdRateThrottle
- AnonThumbnailRateThrottle
- BurstRateThrottle
- EnhancedOAuth2IdBurstRateThrottle
- EnhancedOAuth2IdSustainedRateThrottle
- ExemptOAuth2IdRateThrottle
- OAuth2IdBurstRateThrottle
- OAuth2IdSustainedRateThrottle
- OAuth2IdThumbnailRateThrottle
- OnePerSecond
- OneThousandPerMinute
- SustainedRateThrottle
- TenPerDay
 
- catalog.api.utils.validate_images module
- catalog.api.utils.watermark module
- catalog.api.utils.waveform module
- Module contents
 
- catalog.api.views package- Submodules
- catalog.api.views.audio_views module- AudioViewSet- AudioViewSet.default_index
- AudioViewSet.get_queryset()
- AudioViewSet.list()
- AudioViewSet.model_class
- AudioViewSet.qa_index
- AudioViewSet.query_serializer_class
- AudioViewSet.related()
- AudioViewSet.report()
- AudioViewSet.retrieve()
- AudioViewSet.serializer_class
- AudioViewSet.stats()
- AudioViewSet.thumbnail()
- AudioViewSet.waveform()
 
 
- catalog.api.views.health_views module
- catalog.api.views.image_views module- ImageViewSet- ImageViewSet.OEMBED_HEADERS
- ImageViewSet.default_index
- ImageViewSet.get_queryset()
- ImageViewSet.list()
- ImageViewSet.model_class
- ImageViewSet.oembed()
- ImageViewSet.qa_index
- ImageViewSet.query_serializer_class
- ImageViewSet.related()
- ImageViewSet.report()
- ImageViewSet.retrieve()
- ImageViewSet.serializer_class
- ImageViewSet.stats()
- ImageViewSet.thumbnail()
- ImageViewSet.watermark()
 
 
- catalog.api.views.media_views module- MediaViewSet- MediaViewSet.default_index
- MediaViewSet.get_db_results()
- MediaViewSet.get_queryset()
- MediaViewSet.get_serializer_context()
- MediaViewSet.list()
- MediaViewSet.lookup_field
- MediaViewSet.lookup_value_regex
- MediaViewSet.model_class
- MediaViewSet.pagination_class
- MediaViewSet.qa_index
- MediaViewSet.query_serializer_class
- MediaViewSet.related()
- MediaViewSet.report()
- MediaViewSet.stats()
- MediaViewSet.swagger_schema
- MediaViewSet.thumbnail()
 
 
- catalog.api.views.oauth2_views module
- Module contents
 
Submodules#
catalog.api.admin module#
- class catalog.api.admin.AudioAdmin(model, admin_site)#
- Bases: - ModelAdmin- property media#
 - search_fields = ('identifier',)#
 
- class catalog.api.admin.AudioReportAdmin(model, admin_site)#
- Bases: - MediaReportAdmin- property media#
 - media_specific_list_display = ('audio_url',)#
 
- class catalog.api.admin.ImageAdmin(model, admin_site)#
- Bases: - ModelAdmin- property media#
 - search_fields = ('identifier',)#
 
- class catalog.api.admin.ImageReportAdmin(model, admin_site)#
- Bases: - MediaReportAdmin- property media#
 - media_specific_list_display = ('image_url',)#
 
- class catalog.api.admin.MediaReportAdmin(model, admin_site)#
- Bases: - ModelAdmin- actions = None#
 - autocomplete_fields = ('media_obj',)#
 - get_exclude(request, obj=None)#
- Hook for specifying exclude. 
 - get_list_display(request)#
- Return a sequence containing the fields to be displayed on the changelist. 
 - get_readonly_fields(request, obj=None)#
- Hook for specifying custom readonly fields. 
 - list_display = ('reason', 'status', 'description', 'created_at')#
 - list_display_links = ('status',)#
 - list_filter = ('status', 'reason')#
 - property media#
 - media_specific_list_display = ()#
 - search_fields = ('description', 'media_obj__identifier')#