Merge branch 'release/0.19.0'

.mailmap

@@ -0,0 +1,36 @@
+Alex Schiller <alexschiller@gmail.com> Alexander Schiller <alexschiller@gmail.com>
+Alex Schiller <alexschiller@gmail.com> alexschiller <alexschiller@gmail.com>
+Andrew Sallans <andrew.sallans@gmail.com>
+Austin Macdonald <asmacdo@gmail.com> Austin <asmacdo@gmail.com>
+Austin Macdonald <asmacdo@gmail.com> asmacdo <asmacdo@gmail.com>
+Barrett Harber <barrett.harber@gmail.com>
+Casey Rollins <cmr3rm@virginia.edu>
+Chris Seto <chriskseto@gmail.com>
+Daniel Neis Araujo <danielneis@gmail.com>
+Darion Cassel <darion.cassel@gmail.com>
+Dawn Pattison <pattison.dawn.r@gmail.com>
+Elijah Hamovitz <elijahhamovitz@gmail.com>
+Eric Bower <neurosnap@gmail.com>
+Erin Braswell <erin.braswell@gmail.com> erinspace <erin.braswell@gmail.com>
+Fitz Elliott <fitz@cos.io>
+Haoyu Chen <hc6as@virginia.edu> haoyuchen1992 <hc6as@virginia.edu>
+Jeffrey Spies <jspies@gmail.com> Jeffrey Spies <github@jeffspies.com>
+Jonathon Love <jon@thon.cc>
+Joshua Carp <jm.carp@gmail.com>
+Kurtis Jungersen <kmjungersen@gmail.com> Kurtis Jungersen <Kurtisjungersen@gmail.com>
+Lyndsy Simon <lyndsy@lyndsysimon.com>
+Matt Frazier <maf7sm@virginia.edu>mfraezz <maf7sm@virginia.edu>
+Matthew Keitelman <zamattiac@gmail.com>
+Megan Kelly <mmk4jq@virginia.edu> megankelly <mmk4jq@virginia.edu>
+Megan Kelly <mmk4jq@virginia.edu> mmk4jq <mmk4jq@virginia.edu>
+Meli Lewis <meli.lewis@gmail.com>
+Michael Haselton <icereval@gmail.com> icereval <icereval@gmail.com>
+Nezar Abdennur <nabdennur@gmail.com>
+Oliver M Daniel <olivermdaniel@gmail.com>
+Peter Fan <peter.j.fan@gmail.com>
+Rafael de Lucena Valle <rafaeldelucena@gmail.com>
+Steven Loria <sloria1@gmail.com> sloria <sloria1@gmail.com>
+Tom Baxter <tkb608@gmail.com> TomBaxter <tkb608@gmail.com>
+Tom Baxter <tkb608@gmail.com> tkb608 <tkb608@gmail.com>
+linse <sschirme@gmail.com>
+

.travis.yml

@@ -16,7 +16,7 @@ install:
   - travis_retry pip install --upgrade pip
   - travis_retry pip install setuptools==30.4.0
   - travis_retry pip install wheel==0.26.0
-  - travis_retry pip install invoke==0.11.1
+  - travis_retry pip install invoke==0.13.0
   - travis_retry invoke wheelhouse --develop
   - travis_retry invoke install --develop
 

AUTHORS.rst

@@ -29,3 +29,4 @@ Contributors
 - Erin Braswell `@erinspace <https://github.com/erinspace>`_
 - Rafael de Lucena Valle `@rafaeldelucena <https://github.com/rafaeldelucena>`_
 - Matthew Keitelman `@zamattiac <https://github.com/zamattiac>`_
+- John Tordoff `@Johnetordoff <https://github.com/Johnetordoff>`_

CHANGELOG

@@ -2,6 +2,18 @@
 ChangeLog
 *********
 
+0.19.0 (2017-02-02)
+===================
+- Feature: MFR errors are now categorized and have error-specific metadata added to then.  If Keen
+logging is enabled, the error metadata will be logged there for future investigation.
+- Fix: The 3D object renderer now imposes a maximum zoom-out limit, so objects can't be shrunk to
+infinitesimalness. (thanks, @johnetordoff!)
+- Fix: MFR docs are once again building on readthedocs.org! (thanks, @johnetordoff!)
+- Code: Update MFR to use invoke 0.13.0. If you have an existing checkout, you will need to
+upgrade invoke manually: pip install invoke==0.13.0 (thanks, @johnetordoff!)
+- Docs: MFR has been verified to work with python 3.5.3 and 3.6.0. From now on, the docs will
+mention which python versions MFR has been verfied to work on. (thanks, @johnetordoff!)
+
 0.18.3 (2017-01-11)
 ===================
 - Fix: Increase max codepygments render size to 200kb from 64kb.

CONTRIBUTING.rst

@@ -24,28 +24,31 @@ Clone the repo: ::
     $ git clone https://github.com/CenterForOpenScience/modular-file-renderer.git
     $ cd modular-file-renderer
 
-Configure development environment and Install the development dependencies.
+Configure development environment and install the development dependencies.
 
 .. note::
 
-    It is recommended that you use a `virtualenv`_ with `virtualenvwrapper`_ during development. Python 3.5 and R are required.
+    It is recommended that you use a `virtualenv`_ with `virtualenvwrapper`_ during development. Python 3.5 or greater, `R`_, and `pspp`_ are required.
 
 .. _virtualenv: http://www.virtualenv.org/en/latest/
 .. _virtualenvwrapper: https://pypi.python.org/pypi/virtualenvwrapper
+.. _R: https://www.r-project.org/
+.. _pspp: https://www.gnu.org/software/pspp/
 
 .. code-block:: bash
 
     # For Mac OS X: Install the latest version of python3.5
     $ brew install python3
-    $ brew install r
+    $ brew install r pspp
 
     # Linux users, probably the same thing but with apt-get
     # If someone wants to update this guide, please do.
 
     $ pip install virtualenv
     $ pip install virtualenvwrapper
     $ mkvirtualenv --python=`which python3` mfr
-    $ pip install invoke==0.11.1
+    $ pip install setuptools==30.4.0
+    $ pip install invoke==0.13.0
 
 
 Lastly, install mfr in development mode. ::

README.md

@@ -6,16 +6,13 @@
 
 A Python package for rendering files to HTML via an embeddable iframe.
 
-### Documentation
+### Compatibility
 
-*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:
+MFR is compatible with Python 3.5 (tested up to 3.5.3) and 3.6.
 
-```bash
-pip install -r doc-requirements.txt
-cd docs
-make
-open _build/html/index.html
-```
+### Documentation
+
+Documentation available at: http://modular-file-renderer.readthedocs.io/en/latest/
 
 ### Setting up
 
@@ -42,7 +39,8 @@ After installing python3.5, create the virtual environment with the following co
 pip install virtualenv
 pip install virtualenvwrapper
 mkvirtualenv --python=`which python3.5` mfr
-pip install invoke==0.11.1
+pip install setuptools==30.4.0
+pip install invoke==0.13.0
 invoke install
 invoke server
 ```
@@ -84,13 +82,22 @@ invoke install --develop
 invoke test
 ```
 
+### Known issues
+
+- Running `invoke install -d` with setuptools v31 or greater can break MFR.  The symptom error message is: `"AttributeError: module 'mfr' has no attribute '__version__'".`  If you encounter this, you will need to remove the file
+`mfr-nspkg.pth` from your virtualenv directory, run `pip install setuptools==30.4.0`, then re-run `invoke install -d`.
+
+- The error `def create_default_context(purpose=ssl.Purpose.SERVER_AUTH, *, cafile=None, capath=None, cadata=None): SyntaxError: invalid syntax` can be fixed by restarting your virtual environment. The problem should not reoccur.
+
+- `invoke $command` results in `'$command' did not receive all required positional arguments!`: this error message occurs when trying to run MFR v0.19.0+ with `invoke<0.13.0`.  Run `pip install invoke==0.13.0`, then retry your command.
+
 ### 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
+Copyright 2013-2017 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.
@@ -106,4 +113,4 @@ 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!](https://cos.io/jobs/)
+Want to help save science? Want to get paid to develop free, open source software? [Check out our openings!](https://cos.io/our-communities/jobs/)

docs/conf.py

@@ -45,7 +45,7 @@
 
 # General information about the project.
 project = u'mfr'
-copyright = u'2016'
+copyright = u'2017'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -96,7 +96,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'kr'
+#html_theme = 'kr'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -175,11 +175,6 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'mfrdoc'
 
-latex_documents = [
-    ('documentation', False),
-]
-
-
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 # On RTD we can't import sphinx_rtd_theme, but it will be applied by

docs/install.rst

@@ -14,15 +14,14 @@ Or download one of the following:
 * tarball_
 * zipball_
 
-Make sure that you have installed pspp, are using python3.5, and have installed invoke for your current python3 version.
+Make sure that you have installed `pspp <https://www.gnu.org/software/pspp/>`_ and are using python 3.5 or greater.
 
-Install the version of invoke found in the requirements.txt file. Currently 0.11.1
-
-Install ``invoke``:
+Install the versions of ``setuptools`` and ``invoke`` found in the requirements.txt file:
 
 .. code-block:: bash
 
-    pip install invoke==0.11.1
+    pip install setuptools==30.4.0
+    pip install invoke==0.13.0
 
 Install requirements:
 

environment.yml

@@ -0,0 +1,30 @@
+name: py35
+dependencies:
+- pip=8.1.1=py35_0
+- python=3.5.1=0
+- setuptools=20.3=py35_0
+- wheel=0.29.0=py35_0
+- pip:
+  - aiohttp==0.18.4
+  - chardet==2.3.0
+  - furl==0.4.2
+  - humanfriendly==2.1
+  - mako==1.0.1
+  - raven==5.27.0
+  - stevedore==1.2.0
+  - tornado==4.3
+  - git+https://github.com/CenterForOpenScience/waterbutler.git@0.19.0#egg=waterbutler
+  - agent==0.1.2
+  - Pygments==2.0.2
+  - pydocx==0.7.0
+  - Pillow==2.8.2
+  - nbconvert==4.2.0
+  - nbformat==4.1.0
+  - traitlets==4.2.2
+  - jsonschema==2.4.0
+  - jinja2==2.7.3
+  - mistune==0.7
+  - docutils==0.12
+  - git+https://github.com/icereval/xlrd.git
+  - markdown==2.6.2
+  - certifi==2015.4.28

mfr/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '0.18.3'
+__version__ = '0.19.0'
 __import__('pkg_resources').declare_namespace(__name__)