package.json

Parse package manifests.

manifest = require('nppm/lib/manifest')
try:
  m = manifest.parse('package.json')
except (FileNotFoundError, manifest.InvalidPackageManifest) as exc:
  print(exc)
  m = None

Specification

name

Required. The name of the package. This may be a scope identifier of the format @scope/package-name, or simply package-name. Allowed characters for the scope and package name are digits, ASCII letters and -_..

{ "name": "@scope-name/package-name" }

version

Required. A SemVer of the package's version.

{ "version": "0.0.1-security" }

engines

Optional. An object that maps engine-names to version numbers. These version numbers should be SemVer too, but that is not a requirement. The actual engine that runs the package will check the version number. The default engine is python which compares against the Python version number.

TODO: PyPy, JPython, Stackless, etc. should match to different engine names.

{
  "engines": {
    "python": ">=3.0.0"
  }
}

repository

Optional. URL to the source code repository where the package is developed. If specified, the URL must be valid.

{ "repository": "https://github.com/nodepy/nodepy" }

license

Required when publishing a package on the registry. The license of the package source code.

{ "license": "MIT" }

bin

Optional. An object that associates script names with a request string that is then executed as the main module when the script is executed.

{
  "bin": {
    "manifest": "cli"
  }
}

scripts

Optional. An object that associates event names with Node.py modules which are executed during various events of the package lifecycle.

{
  "scripts": {
    "post-install": "./bin/install.py",
    "pre-uninstall": "./bin/uninstall.py",
    "pre-dist": "./bin/dist.py"
  }
}

Currently supported fields are:

• pre-script
• pre-install, post-install
• pre-uninstall
• pre-dist, post-dist
• pre-publish, post-publish

Todo

• post-uninstall
• pre-version, post-version
• pre-test, test, post-test
• pre-stop, stop, post-stop
• pre-start, start, post-start
• pre-restart, restart, post-restart

private

Optional. Prevent publication of the package with nppm publish. This is used for packages that want to take advantage of the nppm dependency management but are not actuall supposed to be placed into the public registry. An example of this would be a package that generates the documentation of another project.

{ "private": true }

main

Optional. This field describes the name of the module to load when your package is required by another module. If this field is not specified, the Context._index_files are tried instead (which are index and __init__).

{ "main": "main.py" }

dependencies

Optional.: An object that specifies the dependencies of the package. All values must be valid nppm/lib/semver:Selector syntax, Git URL syntax of the format git+<url>[@<ref>] or relative paths of the format [-e] [./|../]<path>. Dependencies declared here will be installed transitively.

{
  "dependencies": {
    "nppm": "~0.0.8",
    "nppm-registry": "~0.0.3",
    "some-module": "git+https://github.com/someuser/some-module.git@development",
    "local-module": "-e ../local-module"
  }
}

dev-dependencies

Optional. Dependencies that are listed here are required only for developing a package, thus they will only be installed when using nppm install without additional arguments in the directory where the package.json file lives, unless --production is specified. Also, development dependencies will not be installed transitively.

{
  "dev-dependencies": {
    "js-nodepy": "~0.0.2"
  }
}

python-dependencies

Optional. Similar to the dependencies field, but it specifies actual Python modules that the package requires. These modules can be installed by nppm using Pip.

{
  "python-dependencies": {
    "Flask": "==0.12",
    "Flask-HTTPAuth": "==3.2.2",
    "mongoengine": "==0.11.0"
  }
}

dev-python-dependencies

Optional. Python dependencies that are required for developing the package. See the dev-dependencies field for when development dependencies are installed.

{
  "dev-python-dependencies": {
    "mkdocs": ">=0.16.1"
  }
}

extensions

Optional. A field that lists extension modules that will be required once for the package, then events will be dispatched to those extensions. The specified module names must be require()-able from directory that contains the package.json.

Currently supported events are:

• init_extension(package) -- Called when the extension is first initialized for a package.
• module_loaded(module) -- Called when a module that uses the extension was loaded.
• preprocess_python_source(package, filename, source) -- Called by the nodepy.PythonLoader class when a Python source file is loaded, allowing to transform the code before it is executed.

dist

Optional. An object that specifies options for generating an archived distribution of the package with nppm dist.

{
  "dist": {
    "include_files": [],
    "exclude_files": [".hg*"]
  }
}

include_files

Optional. A list of patterns that match the files to include. Matching patterns include files possibly excluded by exclude_files.

exclude_files

Optional. A list of patterns that match the files to exclude from the archive. Note that when installing packages with nppm, it will add default exclude patterns to this list. The actual patterns may change with versions of nppm. When this document was last updated, nppm added the following patterns:

• .svn/*
• .git
• .git/*
• .DS_Store
• *.pyc
• *.pyo
• dist/*
• nodepy_modules/