search

ccnmtl / mediathread

Django application for multimedia annotations facilitating collaboration on video and image analysis. Developed at the Columbia University Center for Teaching and Learning.
https://mediathread.ctl.columbia.edu/
Other
85 stars 35 forks source link
django python

readme

Mediathread

Actions Status Documentation Status

Mediathread is a Django site for multimedia annotations facilitating collaboration on video and image analysis. Developed at the Columbia Center for New Media Teaching and Learning (CCNMTL)

CODE: https://github.com/ccnmtl/mediathread INFO: https://mediathread.info FORUM: https://groups.google.com/group/mediathread

REQUIREMENTS

INSTALLATION

  1. Clone Mediathread

    git clone https://github.com/ccnmtl/mediathread.git

  2. Build the database For Postgres (preferred): A. Create the database createdb mediathread

  3. Customize settings Create a local_settings.py file in the mediathread subdirectory. Override the variables from settings_shared.py that you need to customize for your local installation. At a minimum, you will need to customize your DATABASES dictionary. An example local_settings.py is available in our repository.

    For more extensive customization and template overrides, you can create a deploy_specific directory to house a site-specific settings.py file:

     $ mkdir deploy_specific
 $ touch deploy_specific/__init__.py
 $ touch deploy_specific/settings.py

    Edit the deploy_specific/settings.py and override values in settings_shared.py like the DATABASES dictionary. This is where we add custom settings and templates for our deployment that will not be included in the open-sourced distribution. An example deploy_specific setup is available in our repository.

  4. Build the virtual environment Bootstrap uses virtualenv to build a contained library in ve/. django.mk specifies the build target for creating the virtualenv, and running any of the targets specified in that file will automatically set this up.

    make

The rest of the instructions work like standard Django. See: https://docs.djangoproject.com/ for more details.

  1. Sync the database

    ./manage.py migrate

  2. Run locally (during development only) ./manage.py runserver myhost.example.com:8000

Go to your site in a web browser.

  1. The default database is not very useful. You'll need to create a course and some users. Login with the superuser you created in Step #5.

  2. Navigate to /admin/. Click Courses.

  3. Click the 'Add Course +' link.

    • Click the "+" to make a group. Name it something like "test_course"
    • Click the "+" to make a faculty group. Name it something like "test_course_faculty"
      • In the "Add users to group" field...
        • add yourself as a faculty member by putting your username with a "" in front like this "admin"
        • add some fellow faculty/student accounts -- you can create new accounts right here (read the instructions under the textarea)
      • Click "Save" and then click the upper-right link "Django administration" to get back to the regular site (yeah, not the most intuitive).

  4. Experiment with saving assets by visiting: http://myhost.example.com:8000/save/

DOCKER DEVELOPMENT

[Please note that the docker setup for Mediathread is still experimental. There are likely to be rough edges here.]

If you have docker set up and docker-compose installed, you can get a development environment up and running very quickly. To initialize it, the following steps are recommended:

$ make build
$ docker-compose run web migrate
$ docker-compose run web manage createsuperuser

After that, a simple:

$ docker-compose up

will bring up a development server on port 8000 (if you are running boot2docker, it may end up on a different port) backed by a PostgreSQL database.

If requirements have been updated, you can rebuild the image by re-running make build. Eventually, we'll be automatically publishing the Mediathread Docker image to the Docker Hub and you will instead be able to just run docker pull ccnmtl/mediathread to update.

The usual Django manage.py commands can be run inside the docker compose container like so:

$ docker-compose run web manage help
$ docker-compose run web manage shell

(Note that it's with manage, not manage.py; this is the custom entrypoint script (docker-run.sh) at work.)

You can run the unit tests inside the container with the following command:

$ docker-compose run web manage test --settings=mediathread.settings

That one's a little tricky and unintuitive. Normally, running Mediathread inside the container via docker compose, it will use the settings_compose.py settings file, which contains the configuration for connecting to the PostgreSQL instance running in the other container. For unit tests, you don't want that though, so the command above explicitly sets it back to the default dev settings.

Production deployment with Docker is also possible, though even less tested than development. The settings_docker.py file has the default settings that the docker image uses and is designed to allow you to override/set the important values through environment variables (so configuration can be kept out of the docker image).

CYPRESS

Mediathread has a large set of integration tests, implemented using the Cypress testing infrastructure.

To run the tests, simply run make cypress. This command runs the tests in Firefox "headed" mode by default. You can configure the cypress:test npm script target in package.json differently to change this. Cypress supports a number of browser environments.

To run the tests in interactive mode, first run the standalone integration server, make integrationserver then npm run cypress:ffopen to bring up the interactive test console.

DJANGO SITE INFRASTRUCTURE

Mediathread makes use of the Django Sites framework. https://docs.djangoproject.com/en/2.2/ref/contrib/sites/

By default, Django creates a site called "example.com" with an id of 1. This id is referenced in settings_shared.py as SITE_ID=1.

In your production environment, RENAME example.com to your domain.

If a new site is created, update SITE_ID= in your deploy_specific/settings.py or local_settings.py

ALLOWED_HOSTS

ALLOWED_HOSTS is "a list of strings representing the host/domain names that this Django site can serve. This is a security measure to prevent an attacker from poisoning caches and password reset emails with links to malicious hosts by submitting requests with a fake HTTP Host header, which is possible even under many seemingly-safe web server configurations." More here: https://docs.djangoproject.com/en/2.2/ref/settings/#allowed-hosts

Make sure the ALLOWED_HOSTS is set properly in your deploy_specific/settings.py or local_settings.py

APACHE

For deployment to Apache, see our sample configuration in apache/sample.conf. This directory also contains standard django.wsgi file which can be used with other webservers

FLICKR

In your local_settings.py or (better) deploy_specific/settings.py specify your Flickr api key. DJANGOSHERD_FLICKR_APIKEY='your key here'

FLATPAGES

Mediathread's About & Help pages are constructed using the Django Flat Pages architecture. (https://docs.djangoproject.com/en/2.2/ref/contrib/flatpages/). In order to setup pages for your site, follow these steps:

  1. Navigate to the Mediathread /admin/ area, Flatpages.

  2. Create a new flat page, e.g. url: /help/ or /about/, select your domain site site and add content.

  3. Save.

  4. The page should be immediately available by navigating to yourdomain/help/ or yourdomain/about/

HELP DOCUMENTATION

Our help documentation tailored for the Columbia community and our in-house video upload system is here: http://support.ccnmtl.columbia.edu/knowledgebase/topics/6593.

And, Nate Autune helpfully added this a few months ago, "Thanks to Rebecca Darling from Wellesley College, who graciously gave permission to re-publish her "Mediathread Guide for Students" under a Creative Commons license. Here is a link to where you can download it: http://bit.ly/MediathreadStudentsGuide"

METADATA SUPPORT

  1. Current development on the Mediathread browser extension is aimed at supporting the standard set forth by Schema.org (http://schema.org/). This format includes a system of hierarchal terms and their associated values. Use of the metadata terms itemscope, itemtype, and itemprop are used to help stucture the data such that Mediathread can make sense of what metadata is assocaited to the item or items being brought into the application. Examples of this structure can be found here: http://schema.org/docs/gs.html#microdata_itemscope_itemtype.

  2. Use the Google Rich Snippet test tool to test your structure: http://www.google.com/webmasters/tools/richsnippets

  3. It is also worth noting that the LRMI (Learning Resource Metadata Initiative) has been working with Schema.org in creating a more robust set of property (itemprop) terms that have been accepted into the standard. Some of these terms may be useful in determining what might best describe a data set or collection. Here is a link to this new specification: http://www.lrmi.net/the-specification