• Code repository:

Detailed Documentation

Supported options

The recipe supports the following options:

url
url to a node.js source archive

binary-url
url to a node.js binary archive. You can use placeholders {v} (the desired node version), {p} (platform name), and {a} (CPU architecture). Defaults to https://nodejs.org/dist/v{v}/node-v{v}-{p}-{a}.tar.gz. Ignored if url is set, or if the platform is not recognized.

version
node.js version. Ignored if url is set, or if binary-url is set that doesn't use the {v} placeholder. Default to recipe version. Mean that using recipe=gp.recipe.node==0.10.22.X will install node 0.10.22

npms
a list of package to install with npm. You can specify a package version by using npmname@version. In case you want to specify a package.json generated after a successfull first installation or update, you can add . to the list.

scripts
a list of scripts (optional)

node-path
a list of extra directory to add to NODE_PATH

relative-paths
will generate paths relative to the root buildout directory. this is also honored if 'relative-paths' is in the main buildout section

Example usage

We'll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = test1
...
... [test1]
... recipe = gp.recipe.node
... npms = coffee-script less . 
... scripts = coffee lessc
... """)

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
Installing test1.
...
Generated script '.../bin/lessc'.

Contributors

Gael Pasgrimaud, Author Yusuke Tsutsumi

Change history

18.16.0.1 (2023-04-21)

• Update to 18.16.0

16.20.0.1 (2023-04-18)

• update to 16.20.0
• Stop testing for Python 3.6.
• Claim support for Python 3.11.

16.13.2.1 (2022-02-09)

• update to 16.13.2
• claim support for Python 3.6, 3.7, 3.8, 3.9, 3.10
• Load 'arm64' version of node.js on M1/arm apple machines and others.

13.3.0.1 (2019-12-12)

• update to 13.x

6.2.2.1 (2016-06-28)

• Add support for offline mode in Buildout (-o)
• Quote $PATH variable in order to fix problem when $PATH contains space characters.

0.12.7.1 (2015-09-01)

• allow to specify URL for binary node.js distribution (binary-url)

0.12.3.3 (2015-05-22)

• allow to run non-node scripts (casperjs)
• extend PATH to buildout related paths
• extend NODE_PATH to module dependencies (allow to install .)

0.12.3.2 (2015-05-21)

• Bugfix when using node-directory combined with relative-path

0.12.3.1 (2015-05-21)

• Allow to install node outside parts/ by specifying node-directory options
• Switch to 0.12.3.1

0.12.0.1 (2015-03-12)

• Switch to 0.12.0

0.10.28.0 (2014-06-03)

• Switch to 0.10.28
• relative-paths should be honored

0.10.26.0 (2014-02-28)

• Switch to 0.10.26

0.10.24.0 (2013-12-26)

• Switch to 0.10.24

0.10.22.1 (2013-11-23)

• Switch to 0.10.22
• scripts option is no longer required

0.10.21.1 (2013-11-08)

• Switch to 0.10.21
• Allow dev version
• PEP8

0.10.20.1 (2013-10-14)

• Switch to 0.10.20
• py3 compat

0.10.18.2 (2013-09-13)

• Fixes a failure installing npms when the buildout path contains spaces

0.10.18.1

• Update node version
• Allow to use download cache

0.10.8.1

• Allow to install only node/npm

0.10.5.1

• Now use binary distribution on linux and osx by default. Mean that the recipe no longer require gcc and the installation is way much faster.
• Raise an error if a script does not exist
• Use package version to get the node.js version to install

0.3

• Change npm install script location [Ross Pfahler]

0.1

• Created recipe with ZopeSkel [Gael Pasgrimaud]

Download