MFR (Modular File Renderer)

master Build Status:

develop Build Status:

A Python package for rendering files to HTML via an embeddable iframe.

Documentation

Note: https://readthedocs.org/ is currently unable to build documentation for Python 3.5 projects. The documentation available at https://mfr.readthedocs.io/en/latest/ is outdated (v0.15.0). For the most up-to-date documentation, build locally. Within your checkout, run:

pip install -r doc-requirements.txt
cd docs
make
open _build/html/index.html

Setting up

Install the latest version of python3.5.

For MacOSX users:

brew install python3
# optional, needed for some converters
brew install pspp unoconv

For Ubuntu users:

apt-get install python3
# optional, needed for some converters
apt-get install pspp unoconv

After installing python3.5, create the virtual environment with the following commands:

pip install virtualenv
pip install virtualenvwrapper
mkvirtualenv --python=`which python3.5` mfr
pip install invoke==0.11.1
invoke install
invoke server

Configuring

MFR configuration is done through a JSON file (mfr-test.json) that lives in the .cos directory of your home directory. If this is your first time setting up MFR or its sister project, WaterButler, you probably do not have this directory and will need to create it:

mkdir ~/.cos

The defaults should suffice for most local testing. If you're running the OSF on something other than http://localhost:5000/, you'll need to update the ALLOWED_PROVIDER_DOMAINS settings value:

{
  "SERVER_CONFIG": {
    "ALLOWED_PROVIDER_DOMAINS": ["http://localhost:9999/"]
  }
}

If you encounter the error message TypeError: throw() takes 2 positional arguments but 4 were given, you've run into a core asyncio bug! This bug is triggered by turning on debugging. You'll need to set the SERVER_CONFIG.DEBUG flag to false:

{
  "SERVER_CONFIG": {
    "DEBUG": false
  }
}

Testing

Before running the tests, you will need to install some additional requirements. In your checkout, run:

invoke install --develop
invoke test

Create your own module

Interested in adding support for a new provider or file format? Check out the CONTRIBUTING.rst docs.

License

Copyright 2013-2016 Center for Open Science

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

COS is hiring!

Want to help save science? Want to get paid to develop free, open source software? Check out our openings!