django-pbsmmapi 1.3.4b0__tar.gz

django_pbsmmapi-1.3.4b0/.gitignore

@@ -0,0 +1,72 @@
+*OBSOLETE*
+
+# Compiled source #
+###################
+*.pyc
+
+# Packages #
+############
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+*.db
+
+# OS generated files #
+######################
+.DS_Store
+
+
+# media #
+#########
+media/
+media/*
+
+# backup #
+##########
+__BACKUP__/
+__BACKUP__/*
+
+# data #
+########
+__DATA__/
+__DATA__/*
+
+# media #
+#########
+static/
+static/*
+
+# Redirection #
+############
+
+# front end tooling #
+**/node_modules/**
+**/.sass-cache/**
+*.css.map
+
+# whoosh
+whoosh_index/
+
+Pipfile
+Pipfile.lock
+
+*.egg-info/
+
+.coverage
+.python-version
+.tox/
+
+build/
+django_pbsmmapi.egg-info/
+dist

django_pbsmmapi-1.3.4b0/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 WGBH Educational Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

django_pbsmmapi-1.3.4b0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: django-pbsmmapi
+Version: 1.3.4b0
+Summary: Django models that import content from the PBS MediaManager API
+Author: Bob Donahue
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: <4.0,>=3.10
+Requires-Dist: django>=4.0
+Requires-Dist: huey>=2.5.3
+Requires-Dist: nltk>=3.9
+Requires-Dist: pycaption>=2.2.16
+Requires-Dist: python-dateutil
+Requires-Dist: pytz
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# django-pbsmmapi
+
+Code to model PBS MediaManager objects; scripts to ingest data into those models.
+
+## Introduction
+
+This is a Django app to allow Django-based projects to work with the PBS MediaManager API. It is not expected to be a COMPLETE interface to the entirety of the PBS MediaManager; however it should allow access to all of the primary content object types.
+
+In addition to Django, [huey](https://huey.readthedocs.io/en/latest/) is used for running background ingestion tasks.
+
+## Quick start
+
+1. Add the pbsmmapi apps to your INSTALLED_APPS setting:
+
+```python
+    INSTALLED_APPS = [
+        ...
+        'pbsmmapi',
+        'pbsmmapi.episode',
+        'pbsmmapi.season',
+        'pbsmmapi.show',
+        'pbsmmapi.special',
+        'pbsmmapi.franchise',
+        'pbsmmapi.changelog',
+    ]
+```
+
+2. You ALSO need to have PBS Media Manager credentials - an API KEY and a SECRET KEY. These also go into the `settings.py` file of your project:
+
+```python
+    PBSMM_API_ID = os.environ["PBSMM_API_ID"]
+    PBSMM_API_SECRET = os.environ["PBSMM_API_SECRET"]
+```
+
+It's not a good idea to commit these in plain text. Set them as environment variables (as suggested above) or using some other secret management tool.
+
+3. To ingest shows and/or franchises automatically, configure `PBSMM_SHOW_SLUGS` and/or `PBSMM_FRANCHISE_SLUGS`:
+
+```
+PBSMM_SHOW_SLUGS = [
+    "antiques-roadshow",
+]
+
+PBSMM_FRANCHISE_SLUGS = [
+    "masterpiece",
+]
+```
+
+Huey will attempt to scrape all Show and/or Franchise data, including Specials, Seasons, Episodes, and Assets. The changelog endpoint will also be scraped.
+
+Once a complete ingest has finished, changelog data is used to ingest updated and newly added objects.

django_pbsmmapi-1.3.4b0/README.md

@@ -0,0 +1,51 @@
+# django-pbsmmapi
+
+Code to model PBS MediaManager objects; scripts to ingest data into those models.
+
+## Introduction
+
+This is a Django app to allow Django-based projects to work with the PBS MediaManager API. It is not expected to be a COMPLETE interface to the entirety of the PBS MediaManager; however it should allow access to all of the primary content object types.
+
+In addition to Django, [huey](https://huey.readthedocs.io/en/latest/) is used for running background ingestion tasks.
+
+## Quick start
+
+1. Add the pbsmmapi apps to your INSTALLED_APPS setting:
+
+```python
+    INSTALLED_APPS = [
+        ...
+        'pbsmmapi',
+        'pbsmmapi.episode',
+        'pbsmmapi.season',
+        'pbsmmapi.show',
+        'pbsmmapi.special',
+        'pbsmmapi.franchise',
+        'pbsmmapi.changelog',
+    ]
+```
+
+2. You ALSO need to have PBS Media Manager credentials - an API KEY and a SECRET KEY. These also go into the `settings.py` file of your project:
+
+```python
+    PBSMM_API_ID = os.environ["PBSMM_API_ID"]
+    PBSMM_API_SECRET = os.environ["PBSMM_API_SECRET"]
+```
+
+It's not a good idea to commit these in plain text. Set them as environment variables (as suggested above) or using some other secret management tool.
+
+3. To ingest shows and/or franchises automatically, configure `PBSMM_SHOW_SLUGS` and/or `PBSMM_FRANCHISE_SLUGS`:
+
+```
+PBSMM_SHOW_SLUGS = [
+    "antiques-roadshow",
+]
+
+PBSMM_FRANCHISE_SLUGS = [
+    "masterpiece",
+]
+```
+
+Huey will attempt to scrape all Show and/or Franchise data, including Specials, Seasons, Episodes, and Assets. The changelog endpoint will also be scraped.
+
+Once a complete ingest has finished, changelog data is used to ingest updated and newly added objects.

django_pbsmmapi-1.3.4b0/pbsmmapi/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.3.4b0"

django_pbsmmapi-1.3.4b0/pbsmmapi/abstract/admin.py

@@ -0,0 +1,64 @@
+from django.contrib import admin
+from django.contrib.admin import site
+from django.utils.safestring import mark_safe
+
+# This removed the delete function from the Admin action dropdown.
+# You can 're-add' it, if necessary, by explicitly adding it to the
+# actions parameter for a given ModelAdmin instance.
+site.disable_action("delete_selected")
+
+
+class PBSMMAbstractAdmin(admin.ModelAdmin):
+    actions = [
+        "force_reingest",
+    ]
+    search_fields = [
+        "title",
+    ]
+
+    def force_reingest(self, request, queryset):
+        # queryset is the list of Asset items that were selected.
+        for item in queryset:
+            item.ingest_on_save = True
+            # HOW DO I FIND OUT IF THE save() was successful?
+            item.save()
+
+    force_reingest.short_description = "Reingest selected items."
+
+    def assemble_asset_table(self, obj):
+        asset_list = obj.assets.all()
+        out = get_abstract_asset_table(asset_list)
+        return mark_safe(out)
+
+    assemble_asset_table.short_description = "Assets"
+
+    class Meta:
+        abstract = True
+
+
+def get_abstract_asset_table(object_list):
+    url = "/admin/asset/asset"
+    if len(object_list) < 1:
+        return "(No assets)"
+    out = '<table width="100%" border=2>'
+    out += (
+        '\n<tr style="background-color:'
+        ' #999;l"><th>Title</th><th>Type</th>'
+        "<th>Duration</th><th>Avail?</th><th>API</th></tr>"
+    )
+    for item in object_list:
+        row_color = "#ffffff;"
+
+        out += '\n<tr style="background-color:%s">' % row_color
+        out += '\n\t<td><a href="%s/%d/change/" target="_new">%s</a></td>' % (
+            url,
+            item.id,
+            item.title,
+        )
+        out += "\n\t<td>%s</td>" % item.asset_type
+        out += "\n\t<td>%s</td>" % item.formatted_duration
+        out += "\n\t<td>%s</td>" % item.asset_publicly_available()
+        out += '\n\t<td><a href="%s" target="_new">API</a></td>' % item.api_endpoint
+        out += "\n</tr>"
+    out += "\n</table>"
+    return out

django_pbsmmapi-1.3.4b0/pbsmmapi/abstract/helpers.py

@@ -0,0 +1,26 @@
+from datetime import datetime
+
+import pytz
+
+
+def fix_non_aware_datetime(obj):
+    """
+    Ugh - for SOME REASON some of the DateTime values returned by the PBS MM
+    API are NOT time zone aware. SO - fudge them by adding 00:00:00 UTC (if
+    even a time is not provided) or assume the time is UTC.
+    """
+    if obj is None:
+        return None
+    if ":" not in obj:  # oops no time
+        obj += " 00:00:00"
+    if "+" not in obj:  # no time zone - use UTC
+        if "Z" not in obj:
+            obj += "+00:00"
+    return obj
+
+
+def time_zone_aware_now():
+    """
+    This just sends back a time zone aware "now()" with UTC as the time zone.
+    """
+    return datetime.now(pytz.utc)