Feature/buff-worms (MFR python v3.13 upgrade)

.dockerignore

@@ -2,3 +2,4 @@
 *.pyc
 **/*.pyc
 Dockerfile
+*venv*

.github/workflows/test-build.yml

@@ -5,59 +5,71 @@ on: [push, pull_request, workflow_dispatch]
 jobs:
 
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     env:
-      GHA_DISTRO: ubuntu-20.04
+      GHA_DISTRO: ubuntu-24.04
     if: "!contains(github.event.head_commit.message, 'skip ci')"
     strategy:
       matrix:
-        python-version: [3.6]
+        python-version: [3.13]
     steps:
       - name: Git checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Cache Build Requirements
         id: pip-cache-step
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
-          path: ${{ env.pythonLocation }}
-          key: ${{ env.GHA_DISTRO }}-${{ env.pythonLocation }}-${{ hashFiles('requirements.txt', 'dev-requirements.txt') }}
-      - name: install dependencies
-        if: steps.pip-cache-step.outputs.cache-hit != 'true'
+          path: ~/.cache/pip
+          key: ${{ env.GHA_DISTRO }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'poetry.lock') }}
+
+      - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt
+          python -m pip install poetry==2.1.2 setuptools==80.1.0
+          poetry install --no-root --without=docs --with=dev
 
   runtests:
     name: Run unit tests
     needs: build
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     env:
-      GHA_DISTRO: ubuntu-20.04
+      GHA_DISTRO: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: [3.13]
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.6
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: ${{ matrix.python-version }}
+
       - name: Cache pip
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
-          path: ${{ env.pythonLocation }}
-          key: ${{ env.GHA_DISTRO }}-${{ env.pythonLocation }}-${{ hashFiles('requirements.txt', 'dev-requirements.txt') }}
-      - name: run syntax checks
-        run: |
-          flake8 .
-      - name: build plugins
+          path: ~/.cache/pip
+          key: ${{ env.GHA_DISTRO }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'poetry.lock') }}
+
+      - name: Install test dependencies
         run: |
-          python setup.py develop
-      - name: run unit tests
+          python -m pip install poetry==2.1.2
+          python -m pip install setuptools==80.1.0
+          poetry install --without=docs --with=dev
+
+      - name: Run flake8
+        run: poetry run flake8 .
+
+      - name: Run unit tests
         run: |
-          py.test --cov-report term-missing --cov mfr tests
-      - name: Upload coverage data to coveralls.io
-        run: coveralls --service=github
+          poetry run pytest --cov-report term-missing --cov mfr tests
+
+      - name: Upload coverage to Coveralls
+        run: poetry run coveralls --service=github
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -1,17 +1,12 @@
-FROM python:3.6-slim-buster
+FROM python:3.13-slim
 
-# ensure unoconv can locate the uno library
-ENV PYTHONPATH /usr/lib/python3/dist-packages
 
 RUN usermod -d /home www-data \
     && chown www-data:www-data /home \
-    # -slim images strip man dirs, but java won't install unless this dir exists.
-    && mkdir -p /usr/share/man/man1 \
-    && apt-get update \
-    # HACK: work around bug in install java (dep of libreoffice)
-    && apt-get install -y ca-certificates-java \
+    && apt-get update
+
     # mfr dependencies
-    && apt-get install -y \
+RUN apt-get install -y \
         git \
         make \
         gcc \
@@ -32,32 +27,31 @@ RUN usermod -d /home www-data \
         freecad \
         # pspp dependencies
         pspp \
-        # unoconv dependencies
-        libreoffice \
         # grab gosu for easy step-down from root
-        gosu \
-    && apt-get clean \
-    && apt-get autoremove -y \
-    && rm -rf /var/lib/apt/lists/*
+        gosu
+RUN apt-get clean
+RUN apt-get autoremove -y
+RUN rm -rf /var/lib/apt/lists/*
 
 RUN mkdir -p /code
 WORKDIR /code
 
-RUN pip install -U pip==18.1
-RUN pip install setuptools==37.0.0
-RUN pip install unoconv==0.8.2
+COPY pyproject.toml poetry.lock* /code/
 
-COPY ./requirements.txt /code/
+ENV POETRY_NO_INTERACTION=1 \
+    POETRY_VIRTUALENVS_CREATE=0 \
+    POETRY_VIRTUALENVS_IN_PROJECT=1
 
-RUN pip install --no-cache-dir -r ./requirements.txt
+RUN pip install poetry==2.1.2 setuptools==80.1.0 \
+    && poetry install --no-root --without=docs
 
 # Copy the rest of the code over
 COPY ./ /code/
 
 ARG GIT_COMMIT=
-ENV GIT_COMMIT ${GIT_COMMIT}
+ENV GIT_COMMIT=${GIT_COMMIT}
 
-RUN python setup.py develop
+RUN poetry install --without=docs
 
 EXPOSE 7778
 

README.md

@@ -8,43 +8,40 @@ A Python package for rendering files to HTML via an embeddable iframe.
 
 ### Compatibility
 
-MFR is compatible with Python 3.6.
+MFR is compatible with Python 3.13.
 
 ### Documentation
 
 Documentation available at: http://modular-file-renderer.readthedocs.io/en/latest/
 
 ### Setting up
 
-Install the latest version of python3.6.
+Install the latest version of python3.13.
 
 For MacOSX users:
 
 ```bash
-brew install python3
+brew install python@3.13
 # optional, needed for some converters
-brew install pspp unoconv
+brew install pspp libreoffice
 ```
 For Ubuntu users:
 
 ```bash
-apt-get install python3
+apt-get install python3.13
 # optional, needed for some converters
-apt-get install pspp unoconv
+apt-get install pspp libreoffice
 ```
 
-After installing python3.6, create the virtual environment with the following commands:
+After installing python3.13, set up the project with the following commands:
 
 ```bash
-pip install virtualenv
-pip install virtualenvwrapper
-mkvirtualenv --python=`which python3.6` mfr
+pip install poetry
+poetry env use python3.13
+poetry install
 
-pip install setuptools==37.0.0
-pip install invoke==0.13.0
-
-invoke install
-invoke server
+poetry run invoke install
+poetry run invoke server
 ```
 
 ### Configuring
@@ -80,8 +77,8 @@ If you encounter the error message `TypeError: throw() takes 2 positional argume
 Before running the tests, you will need to install some additional requirements. In your checkout, run:
 
 ```bash
-invoke install --develop
-invoke test
+poetry run invoke install --develop
+poetry run invoke test
 ```
 
 ### Known issues
@@ -98,7 +95,7 @@ Interested in adding support for a new provider or file format? Check out the CO
 
 ### License
 
-Copyright 2013-2023 Center for Open Science
+Copyright 2013-2025 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.

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # MFR documentation build configuration file.
 #
@@ -31,7 +30,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'stevedore.sphinxext']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -46,8 +45,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'mfr'
-copyright = u'2023, Center For Open Science'
+project = 'mfr'
+copyright = '2025, Center For Open Science'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -177,12 +176,7 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'mfrdoc'
 
+# This block will use the same theme when building locally as on RTD.
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-
-# On RTD we can't import sphinx_rtd_theme, but it will be applied by
-# default anyway.  This block will use the same theme when building locally
-# as on RTD.
 if not on_rtd:
-    import sphinx_rtd_theme
     html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

docs/extensions.rst

@@ -11,11 +11,6 @@ CodePygmentsRenderer
 
 .. autoclass:: mfr.extensions.codepygments.CodePygmentsRenderer
 
-DocxRenderer
-------------
-
-.. autoclass:: mfr.extensions.docx.DocxRenderer
-
 ImageExporter
 -------------
 

docs/index.rst

@@ -26,6 +26,7 @@ Guide
    overview
    integrations
    code
+   plugins
 
 Project info
 ------------

docs/install.rst

@@ -14,26 +14,25 @@ Or download one of the following:
 * tarball_
 * zipball_
 
-Make sure that you have installed `pspp <https://www.gnu.org/software/pspp/>`_ and are using python 3.5 or greater.
+Make sure that you have installed `pspp <https://www.gnu.org/software/pspp/>`_ and are using python v3.13 or greater.
 
-Install the versions of ``setuptools`` and ``invoke`` found in the requirements.txt file:
+Install ``poetry`` to manage dependencies:
 
 .. code-block:: bash
 
-    pip install setuptools==37.0.0
-    pip install invoke==0.13.0
+    pip install poetry==2.1.2
 
 Install requirements:
 
 .. code-block:: bash
 
-    invoke install
+    poetry install
 
 Or for some nicities (like tests):
 
 .. code-block:: bash
 
-    invoke install --develop
+    poetry install --with dev
 
 Start the server:
 
@@ -45,7 +44,7 @@ Start the server:
 
 .. code-block:: bash
 
-    invoke server
+    poetry run invoke server
 
 .. _Github: https://github.com/CenterForOpenScience/modular-file-renderer
 .. _tarball: https://github.com/CenterForOpenScience/modular-file-renderer/tarball/master

docs/plugins.rst

@@ -0,0 +1,20 @@
+
+Plugins
+-------
+
+Auth Providers
+==============
+
+.. list-plugins:: mfr.providers
+   :detailed:
+
+Exporters
+=========
+
+.. list-plugins:: mfr.exporters
+
+Renderers
+=========
+
+.. list-plugins:: mfr.renderers
+