MFR (Modular File Renderer)

master Build Status:

develop Build Status:

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

Startup commands

Install the latest version of python3.5.

For MacOSX users:

brew install python3
brew install r

For Ubuntu users:

apt-get install python3
apt-get install r-base

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 --develop
invoke server

Testing Configuration (optional)

MFR looks for local configuration in ~/.cos/mfr-test.json. 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 SERVER_CONFIG.DEBUG to false in your mfr-test.json, e.g.

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

Create your own module

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

License

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!