https://github.com/mfcovington/djangocms-genome-browser

A Django app for incorporating a Dalliance genome browser into a Django site with django CMS-specific features
https://github.com/mfcovington/djangocms-genome-browser

Last synced: over 1 year ago
JSON representation

A Django app for incorporating a Dalliance genome browser into a Django site with django CMS-specific features

• Host: GitHub
• URL: https://github.com/mfcovington/djangocms-genome-browser
• Owner: mfcovington
• License: bsd-3-clause
• Created: 2015-04-26T06:18:10.000Z (about 11 years ago)
• Default Branch: develop
• Last Pushed: 2016-02-09T05:16:00.000Z (over 10 years ago)
• Last Synced: 2025-03-20T14:40:26.941Z (over 1 year ago)
• Language: Python
• Homepage: https://github.com/mfcovington/djangocms-genome-browser/releases/download/0.1.1/djangocms-genome-browser-0.1.1.tar.gz
• Size: 40 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
************************

djangocms-genome-browser

************************

``djangocms-genome-browser`` is a Django app for incorporating a Dalliance genome browser into a Django site with django CMS-specific features.

Source code is available on GitHub at `mfcovington/djangocms-genome-browser `_. Information about and source code for the Dalliance genome browser are available on `Biodalliance `_ and `GitHub `_, respectively.

.. contents:: :local:

Installation

============

**GitHub (development branch)**

.. code-block:: sh

    pip install git+http://github.com/mfcovington/djangocms-genome-browser.git@develop

Configuration

=============

- `Install django CMS and start a project `_, if one doesn't already exist.

  - Unless you use this app as part of `djangocms-lab-site `_ or plan to style the app from scratch, you will want to choose the ``Use Twitter Bootstrap Theme`` option (when running ``djangocms``) and then edit the resulting ``templates/base.html``. This will add style that looks like Bootstrap 2. To use Bootstrap 3 styling, remove the following line for the ``bootstrap-theme.min.css`` stylesheet from ``templates/base.html``:

    .. code-block:: python

        

- Do the following in ``settings.py``:

  - Add ``cms_genome_browser`` and its dependencies to ``INSTALLED_APPS``:

    .. code-block:: python

        INSTALLED_APPS = (

            # ...

            'cms_genome_browser',

            'easy_thumbnails',

            'filer',

            'mptt',

        )

  - Add ``easy_thumbnail`` settings: 

    .. code-block:: python

        # For easy_thumbnails to support retina displays (recent MacBooks, iOS)

        THUMBNAIL_HIGH_RESOLUTION = True

        THUMBNAIL_QUALITY = 95

        THUMBNAIL_PROCESSORS = (

            'easy_thumbnails.processors.colorspace',

            'easy_thumbnails.processors.autocrop',

            'filer.thumbnail_processors.scale_and_crop_with_subject_location',

            'easy_thumbnails.processors.filters',

        )

        THUMBNAIL_PRESERVE_EXTENSIONS = ('png', 'gif')

        THUMBNAIL_SUBDIR = 'versions'

Migrations

==========

Create and perform ``cms_genome_browser`` migrations:

.. code-block:: sh

    python manage.py makemigrations cms_genome_browser

    python manage.py migrate

Usage

=====

- Start the development server:

.. code-block:: sh

    python manage.py runserver

- Visit: ``http://127.0.0.1:8000/``

- Create a CMS page.

- Attach the ``Genome Browser App`` under ``Advanced Settings`` for the page.

*Version 0.1.1*