mmcif.sitegen 0.25

mmCIF Dictionary Site Generator

mmCIF Dictionary Site Generator

Introduction

This module contains a collection of utilities to generate HTML and image content for the mmCIF Resource Site

Installation

Install from PyPi using:

pip install mmcif.sitegen

To install from source, download the library source software from the project repository:

git clone  https://github.com/rcsb/py-mmcif_sitegen.git

cd py-mmcif_sitegen
pip install -e .

Optionally, run the test suite, using:

python setup.py test

or

tox

A command line entry point with the following options is provided to generate html and images:

 site_generator_cli --help

usage: SiteGeneratorExec.py [-h] [--web_gen_path WEB_GEN_PATH]
       [--web_file_assets_path WEB_FILE_ASSETS_PATH] [--html] [--images] [--test_mode_flag]

optional arguments:
  -h, --help            show this help message and exit
  --web_gen_path WEB_GEN_PATH
                        Top path to website generated content
  --web_file_assets_path WEB_FILE_ASSETS_PATH
                        Top path for website source file assests
  --html                Generate HTML content
  --images              Generate image content
  --test_mode_flag      Test mode flag (default=False)

For example, the following script illustrates the steps required to materialize the dynamic content and integrate this with static files of the mmCIF resource site.

#!/bin/bash
cd /var/www
echo "# Cloning static content for mmCIF website"
git clone https://github.com/rcsb/mmcif_website.git
echo "# Cloning file assets for mmCIF website"
git clone https://github.com/rcsb/mmcif_website_file_assets.git
# ---
echo "# Generating image content"
/usr/local/bin/site_generator_cli --images \
  --web_gen_path /var/www/mmcif_website_generated \
  --web_file_assets_path /var/www/mmcif_website_file_assets
#
echo "# Generating site content"
/usr/local/bin/site_generator_cli --html   \
  --web_gen_path /var/www/mmcif_website_generated \
  --web_file_assets_path /var/www/mmcif_website_file_assets
#
echo "# Update search indices"
/var/www/mmcif_website/mmcif_cgi/swish/MakeIndices.sh