Skip to content

[ENG-8426] | Update README with Poetry-based setup steps for local MFR … #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2025
Merged

[ENG-8426] | Update README with Poetry-based setup steps for local MFR … #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 15 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]
# 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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down