Skip to content

Commit

Permalink
Document required Python version
Browse files Browse the repository at this point in the history
The error I was getting is

> AttributeError: module 'collections' has no attribute 'MutableSet'

Googled the error, sounded like it might be related to [1]. Downgrading
Python to version used here worked.

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1791952
  • Loading branch information
lawrence-forooghian committed Nov 21, 2023
1 parent 53f940f commit 09a2b9b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
nodejs 8.17.0
ruby 2.6.4
python 3.8.18
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ Returns a `Uint8Array`, the 'target', being the result of applying `delta` to `s

### Requirements

#### Node.js

The `vcdiff` dev dependency of this project, used for testing, fails to build against [Node.js 9](https://nodejs.org/download/release/latest-v9.x/) and newer.
For this reason, until [#3](https://github.com/ably-forks/vcdiff-decoder/issues/3) has been addressed, the tests must be run against an environment with [Node.js 8](https://nodejs.org/download/release/latest-v8.x/) installed.

Expand All @@ -94,6 +96,16 @@ or compatible tooling to manage their Node.js runtime versions, we have included
[`.tool-versions`](.tool-versions)
file.

#### Python

The version of `node-gyp` bundled with the above-mentioned version of NPM uses an API that was removed in Python 3.9, causing `npm install` to fail. So, you must use Python 3.8 or earlier.

For those who use
[ASDF](https://github.com/asdf-vm/asdf)
or compatible tooling to manage their Python runtime versions, we have included a
[`.tool-versions`](.tool-versions)
file.

### Building

You can trigger a build using Webpack with:
Expand Down

0 comments on commit 09a2b9b

Please sign in to comment.