Skip to content

Commit 7d7caad

Browse files
committed
Merge branch 'feature/update-readme' into feature/buff-worms
Closes #402 [ENG-8426]
2 parents 9e2e128 + 5fa2054 commit 7d7caad

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,40 @@ A Python package for rendering files to HTML via an embeddable iframe.
88

99
### Compatibility
1010

11-
MFR is compatible with Python 3.6.
11+
MFR is compatible with Python 3.13.
1212

1313
### Documentation
1414

1515
Documentation available at: http://modular-file-renderer.readthedocs.io/en/latest/
1616

1717
### Setting up
1818

19-
Install the latest version of python3.6.
19+
Install the latest version of python3.13.
2020

2121
For MacOSX users:
2222

2323
```bash
24-
brew install python3
24+
brew install [email protected]
2525
# optional, needed for some converters
26-
brew install pspp unoconv
26+
brew install pspp libreoffice
2727
```
2828
For Ubuntu users:
2929

3030
```bash
31-
apt-get install python3
31+
apt-get install python3.13
3232
# optional, needed for some converters
33-
apt-get install pspp unoconv
33+
apt-get install pspp libreoffice
3434
```
3535

36-
After installing python3.6, create the virtual environment with the following commands:
36+
After installing python3.13, set up the project with the following commands:
3737

3838
```bash
39-
pip install virtualenv
40-
pip install virtualenvwrapper
41-
mkvirtualenv --python=`which python3.6` mfr
39+
pip install poetry
40+
poetry env use python3.13
41+
poetry install
4242

43-
pip install setuptools==37.0.0
44-
pip install invoke==0.13.0
45-
46-
invoke install
47-
invoke server
43+
poetry run invoke install
44+
poetry run invoke server
4845
```
4946

5047
### Configuring
@@ -80,8 +77,8 @@ If you encounter the error message `TypeError: throw() takes 2 positional argume
8077
Before running the tests, you will need to install some additional requirements. In your checkout, run:
8178

8279
```bash
83-
invoke install --develop
84-
invoke test
80+
poetry run invoke install --develop
81+
poetry run invoke test
8582
```
8683

8784
### Known issues
@@ -98,7 +95,7 @@ Interested in adding support for a new provider or file format? Check out the CO
9895

9996
### License
10097

101-
Copyright 2013-2023 Center for Open Science
98+
Copyright 2013-2025 Center for Open Science
10299

103100
Licensed under the Apache License, Version 2.0 (the "License");
104101
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)