# mmCIF Dictionary Site Generator
[](https://dev.azure.com/rcsb/RCSB%20PDB%20Python%20Projects/_build/latest?definitionId=30&branchName=master)
## Introduction
This module contains a collection of utilities to generate HTML and image
content for the [mmCIF Resource Site](mmcif.wwpdb.org)
## Installation
Install from PyPi using:
```bash
pip install mmcif.sitegen
```
To install from source, download the library source software from the project repository:
```bash
git clone https://github.com/rcsb/py-mmcif_sitegen.git
cd py-mmcif_sitegen
pip install -e .
```
Optionally, run the test suite, using:
```bash
python setup.py test
or
tox
```
A command line entry point with the following options is provided to generate html and images:
```bash
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.
```bash
#!/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
```
Raw data
{
"_id": null,
"home_page": "http://mmcif.wwpdb.org",
"name": "mmcif.sitegen",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "John Westbrook",
"author_email": "john.westbrook@rcsb.org",
"download_url": "https://files.pythonhosted.org/packages/fd/3c/1d2d035647ae5355ccd16816d2b8664a23ba7d929eff436f96f8e5e5c21d/mmcif.sitegen-0.26.tar.gz",
"platform": null,
"description": "# mmCIF Dictionary Site Generator\n\n[](https://dev.azure.com/rcsb/RCSB%20PDB%20Python%20Projects/_build/latest?definitionId=30&branchName=master)\n\n## Introduction\n\nThis module contains a collection of utilities to generate HTML and image\ncontent for the [mmCIF Resource Site](mmcif.wwpdb.org)\n\n## Installation\n\nInstall from PyPi using:\n\n```bash\npip install mmcif.sitegen\n```\n\nTo install from source, download the library source software from the project repository:\n\n```bash\n\ngit clone https://github.com/rcsb/py-mmcif_sitegen.git\n\ncd py-mmcif_sitegen\npip install -e .\n\n```\n\nOptionally, run the test suite, using:\n\n```bash\n\npython setup.py test\n\nor\n\ntox\n\n```\n\nA command line entry point with the following options is provided to generate html and images:\n\n```bash\n site_generator_cli --help\n\nusage: SiteGeneratorExec.py [-h] [--web_gen_path WEB_GEN_PATH]\n [--web_file_assets_path WEB_FILE_ASSETS_PATH] [--html] [--images] [--test_mode_flag]\n\noptional arguments:\n -h, --help show this help message and exit\n --web_gen_path WEB_GEN_PATH\n Top path to website generated content\n --web_file_assets_path WEB_FILE_ASSETS_PATH\n Top path for website source file assests\n --html Generate HTML content\n --images Generate image content\n --test_mode_flag Test mode flag (default=False)\n\n```\n\nFor example, the following script illustrates the steps required to\nmaterialize the dynamic content and integrate this with static files\nof the mmCIF resource site.\n\n```bash\n#!/bin/bash\ncd /var/www\necho \"# Cloning static content for mmCIF website\"\ngit clone https://github.com/rcsb/mmcif_website.git\necho \"# Cloning file assets for mmCIF website\"\ngit clone https://github.com/rcsb/mmcif_website_file_assets.git\n# ---\necho \"# Generating image content\"\n/usr/local/bin/site_generator_cli --images \\\n --web_gen_path /var/www/mmcif_website_generated \\\n --web_file_assets_path /var/www/mmcif_website_file_assets\n#\necho \"# Generating site content\"\n/usr/local/bin/site_generator_cli --html \\\n --web_gen_path /var/www/mmcif_website_generated \\\n --web_file_assets_path /var/www/mmcif_website_file_assets\n#\necho \"# Update search indices\"\n/var/www/mmcif_website/mmcif_cgi/swish/MakeIndices.sh\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "mmCIF Dictionary Site Generator",
"version": "0.26",
"project_urls": {
"Homepage": "http://mmcif.wwpdb.org"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd3c1d2d035647ae5355ccd16816d2b8664a23ba7d929eff436f96f8e5e5c21d",
"md5": "66a8ea0d56a764bb73683245fc3b94ab",
"sha256": "1b2f41ae01203fcbed64626af4d668cc971fc820da1d43df11bcb41b3cabc63b"
},
"downloads": -1,
"filename": "mmcif.sitegen-0.26.tar.gz",
"has_sig": false,
"md5_digest": "66a8ea0d56a764bb73683245fc3b94ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32778,
"upload_time": "2024-02-06T23:35:06",
"upload_time_iso_8601": "2024-02-06T23:35:06.494731Z",
"url": "https://files.pythonhosted.org/packages/fd/3c/1d2d035647ae5355ccd16816d2b8664a23ba7d929eff436f96f8e5e5c21d/mmcif.sitegen-0.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-06 23:35:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mmcif.sitegen"
}
JSON