From 5fa205484fdb3c89917dc69ad138b3a14d00e388 Mon Sep 17 00:00:00 2001
From: Andriy Sheredko <sheredko.andriy@gmail.com>
Date: Tue, 12 Aug 2025 17:17:47 +0300
Subject: [PATCH] ENG-8426 | Update README with Poetry-based setup steps for
 local MFR development

---
 README.md | 33 +++++++++++++++------------------
 1 file changed, 15 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index c8bb4b69..718bf84f 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ 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
 
@@ -16,35 +16,32 @@ Documentation available at: http://modular-file-renderer.readthedocs.io/en/lates
 
 ### 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.