Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Installing patsy

phun-ky edited this page · 5 revisions

For general installation instructions, please read the Installation-section here. For a more in-dept guide on how to install patsy, read on.

Table of Contents

  1. Overview
  2. Installing patsy

Overview

The npm module patsy should be installed globally. It puts the patsy command in your PATH so you can execute it in any project you have.

If you have installed patsy globally in the past, you will need to remove it with npm uninstall -g patsy first.

If you want to, you can add patsy as part of your devDependencies in your project's package.json, if you use one that is, and instruct users to do npm install than to have users install patsy manually. Utilizing package.json makes the task of installing patsy (and any other dev dependencies) much easier and less error-prone. But be sure to inform your users that patsy have to be installed globally!

⬆ Go to the TOC

Installing patsy

Installing a specific version of patsy

If you need a specific version of patsy, run npm install patsy@VERSION -g --save-dev where VERSION is the version you need, and npm will install that version of patsy, adding it to your package.json devDependencies if chosen.

Note that a tilde version range will be automatically specified in package.json. This is typically good, as new patch releases of the specified version will be installable by npm. If you don't want this behavior, manually edit your package.json and remove the ~ (tilde) from the version number. This will lock in the exact version that you have specified.

⬆ Go to the TOC

Installing a published development version of patsy

Periodically, as new functionality is being developed, patsy builds will be published to npm. These builds will not be published as a @latest official release, and will typically have a build number or alpha/beta/release candidate designation.

Like installing a specific version of patsy, run npm install patsy@VERSION -g --save-dev where VERSION is the version you need, and npm will install that version of patsy, adding it to your package.json devDependencies.

Note that regardless of the version you specify, a tilde version range will be specified in package.json. This is very bad, as new, possibly incompatible, patch releases of the specified development version may be installed by npm, breaking your build.

In this case it is very important that you manually edit your package.json and remove the ~ (tilde) from the version number. This will lock in the exact development version that you have specified.

⬆ Go to the TOC

Installing an unpublished development version of patsy

If you want to install a bleeding-edge, unpublished version of patsy, follow the instructions for specifying a git URL as a dependency and be sure to specify an actual commit SHA (not a branch name) as the commit-ish. This will guarantee that your project always uses that exact version of patsy.

The specified git URL may be that of the official patsy repo or a fork.

After you have cloned the patsy project in your folder be sure to fetch the required dependencies before you start developing:

C:\Workspace\patsy-fork\\[sudo ]npm install
C:\Workspace\patsy-fork\npm link

This will create a patsy symlink to node_modules\.bin\patsy to allow patsy to be run as though it was installed globally.

⬆ Go to the TOC

Installing patsy locally

You may install patsy locally to a project using npm install patsy --save-dev but instead of being able to access the patsy command from anywhere, you'll need to specify its explicit local path, which will be something like ./node_modules/.bin/patsy.

Using patsy in this way is unsupported!

⬆ Go to the TOC

Something went wrong with that request. Please try again.