Skip to content

Commit d2f3e7c

Browse files
Johnetordofffelliott
authored andcommitted
Update docs with new Known Issue and compatibility message
1 parent d10429b commit d2f3e7c

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
A Python package for rendering files to HTML via an embeddable iframe.
88

9+
### Compatibility
10+
11+
MFR is compatible with Python 3.5 (tested up to 3.5.3) and 3.6.
12+
13+
914
### Documentation
1015

1116
Documentation available at: http://modular-file-renderer.readthedocs.io/en/latest/
@@ -80,11 +85,10 @@ invoke test
8085

8186
### Known Issues
8287

83-
Running invoke install -d with setuptools v31 can break waterbutler. The symptom error message is: "AttributeError:
84-
module 'mfr' has no attribute '__version__'". If you encounter this, you will need to remove the file
85-
mfr-nspkg.pth from your virtualenv directory, run `pip install setuptools==30.4.0`, then re-run `invoke install -d`.
88+
- 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
89+
`mfr-nspkg.pth` from your virtualenv directory, run `pip install setuptools==30.4.0`, then re-run `invoke install -d`.
8690

87-
#
91+
- 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.
8892

8993
### Create your own module
9094

0 commit comments

Comments
 (0)