mfr rewrite as a service w/ cloud storage

.gitignore

@@ -18,8 +18,7 @@ Thumbs.db
 # Python
 #######################
 *.py[cod]
-*.so
-*.py[cod]
+**/*.pyc
 
 # C extensions
 *.so

.travis.yml

@@ -5,14 +5,8 @@ language: python
 sudo: false
 
 python:
-  - "2.6"
-  - "2.7"
   - "3.3"
   - "3.4"
-  # TODO(asmacdo)
-  # pypy is unable to install numpy and pandas. The test should either not
-  # install pandas or it should install from the pypy repo.
-  # - "pypy"
 
 install:
     - travis_retry pip install -r dev-requirements.txt

AUTHORS.rst

@@ -21,4 +21,7 @@ Contributors
 - Lyndsy Simon `@lyndsysimon <https://github.com/lyndsysimon>`_
 - Jeffrey Spies `@JeffSpies <https://github.com/JeffSpies>`_
 - Matt Frazier `@mfraezz <https://github.com/mfraezz>`_
-- Casey Rollins `@caseyrollins <https://github.com/caseyrollins>`_
+- Casey Rollins `@caseyrollins <https://github.com/caseyrollins>`_
+- Michael Haselton `@icereval <https://github.com/icereval>`_
+- Megan Kelly `@megankelly <https://github.com/megankelly>`_
+- Chris Seto `@chrisseto <https://github.com/chrisseto>`_

CONTRIBUTING.rst

@@ -34,15 +34,14 @@ Install the development dependencies.
 
 ::
 
-    $ pip install -r dev-requirements.txt
-
-
+    $ pip install -U -r dev-requirements.txt
 
 
 Lastly, install mfr in development mode. ::
 
     $ python setup.py develop
 
+    $ invoke server
 
 Running tests
 -------------
@@ -59,16 +58,17 @@ You can also use pytest directly. ::
 Writing tests
 -------------
 
-Unit tests should be written for all rendering, exporting, and detection code.
+Unit tests should be written for all rendering code.
 
-Tests can be written as functions, like so:
+Tests should be encapsulated within a class and written as functions, like so:
 
 .. code-block:: python
 
     # in test_myformat.py
 
     from mfr_something import render
 
+
     def test_render_html():
         with open('testfile.mp4') as fp:
             assert render.render_html(fp) == '<p>rendered testfile.mp4</p>'
@@ -88,34 +88,6 @@ The above test can be rewritten like so:
 
 .. _pytest fixtures: https://pytest.org/latest/fixture.html
 
-Using the player
-----------------
-
-The mfr comes with a Flask app for previewing rendered files. Create a ``files/`` subdirectory in ``player`` and copy the files you want to render into it. Then run the app from the ``player`` directory with ::
-
-    $ invoke player
-
-Then browse to ``localhost:5000`` in your browser.
-
-Configuring the player
-++++++++++++++++++++++
-
-You will likely want to add additional filehandler modules to the player. The first time you run ``invoke player``, a file is created at ``player/mfr_config_local.py``. You can add additional handlers to the ``HANDLERS`` list and add any additional configuration here.
-
-.. code-block:: python
-
-    # in player/mfr_config_local.py
-
-    import mfr_image
-    import mfr_code_pygments
-
-    # Add additional handlers here
-    HANDLERS = [
-        mfr_image.Handler,
-        mfr_code_pygments.Handler,
-    ]
-
-
 
 Writing A File Format Package
 -----------------------------
@@ -126,15 +98,14 @@ There are two main pieces of a file format package are
 - Your :class:`FileHandler <mfr.core.FileHandler>`
 
 
-Rendering/Exporting Code
+Rendering Code
 ++++++++++++++++++++++++
 
-Renderers are simply callables (functions or methods) that take a file as their first argument and return a :class:`RenderResult <mfr.core.RenderResult>` which contains content(a string of the rendered HTML) and assets (a dictionary that points to lists of javascript or css sources).
+Renderers are simply callables (functions or methods) that take a file as their first argument and return
 
 Here is a very simple example of function that takes a filepointer and outputs a render result with an HTML image tag.
 
 .. code-block:: python
-    from mfr import RenderResult
 
     def render_img_tag(filepointer):
         filename = filepointer.name
@@ -205,51 +176,38 @@ Each package has its own directory. At a minimum, your package should include:
 
 Apart from those files, you  are free to organize your rendering and export code however you want.
 
-A typical directory structure might look like this:
+A typical extension plugin directory structure might look like this:
 
 ::
 
-	mfr
-	└──mfr-something
-		├── export-requirements.txt
-		├── render-requirements.txt
-		├── __init__.py
-		├── render.py
-		├── export.py
-		├── static
-		│   ├── js
-		│   └── css
-		├── tests
-		│   ├── __init__.py
-		│   └── test_something.py
-		├── templates
-		│   └── something.html
-		├── libs
-		│   ├── __init__.py
-		│   └── something_tools.py
-		├── setup.py
-		├── README.rst
-		└── configuration.py
-
-where "something" is a file format, e.g. "mfr_image", "mfr_movie".
-
-.. note::
-
-    You may decide to make subdirectories for rendering and exporting code if single files start to become very large.
-
-
-Use a template
-++++++++++++++
-
-The fastest way to get started on a module is to use `cookiecutter template`_ for mfr modules. This will create the directory structure above.
-
-::
-
-    $ pip install cookiecutter
-    $ cookiecutter https://github.com/CenterForOpenScience/cookiecutter-mfr.git
-
-.. _cookiecutter template: https://github.com/CenterForOpenScience/cookiecutter-mfr
-
+	modular-file-renderer
+	├──mfr
+	│	├── __init__.py
+	│	└──extensions
+	│		├── __init__.py
+	│		└──custom-plugin
+	│			├── __init__.py
+	│			├── render.py
+	│			├── export.py
+	│			├── settings.py
+	│			├── static
+	│			│	├── css
+	│			│	└── js
+	│			├── templates
+	│			│	└── viewer.mako
+	│			└── libs
+	│				├── __init__.py
+	│				└── tools.py
+	├──tests
+	│	├── __init__.py
+	│	└──extnesions
+	│		├── __init__.py
+	│		└──custom-plugin
+	│			├── __init__.py
+	│			└── test_custom_plugin.py
+	├── setup.py
+	├── README.md
+	└── requirements.py
 
 
 Documentation

NOTICE

@@ -1,38 +1,2 @@
 mfr includes code from 3rd-party libraries, whose licenses are listed below.
 
-Flask License
-=============
-
-Copyright (c) 2014 by Armin Ronacher and contributors.  See AUTHORS
-for more details.
-
-Some rights reserved.
-
-Redistribution and use in source and binary forms of the software as well
-as documentation, with or without modification, are permitted provided
-that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright
-  notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above
-  copyright notice, this list of conditions and the following
-  disclaimer in the documentation and/or other materials provided
-  with the distribution.
-
-* The names of the contributors may not be used to endorse or
-  promote products derived from this software without specific
-  prior written permission.
-
-THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
-CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
-NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
-OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGE.

README.md

@@ -0,0 +1,34 @@
+#MFR
+
+**WARNING: mfr is in a very alpha stage of development. As such, it's API is in constant flux. Expect many breaking changes.**
+
+**mfr** (short for "modular file renderer") is a Python package for rendering files to HTML.
+
+### startup commands
+
+```bash
+# Make sure that you are using >= python3.3
+pip install -U -r requirements.txt
+python setup.py develop
+invoke server
+```
+
+### Create your own module
+
+Interested in adding support for a new provider or file format? Check out the CONTRIBUTING.rst docs.
+
+### License 
+
+Copyright 2013-2015 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.