Pants v2: Fast, consistent builds for Python and more

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started

The IPython enhanced REPL (

Config section: [ipython]

Basic options


Advanced options

default: ipython==7.16.1
Requirement string for the tool.

--ipython-extra-requirements="['<str>', '<str>', ...]"
default: []
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.

default: IPython:start_ipython
The main module for the tool. If unspecified, the code using this tool must provide it explicitly on invocation, or it can use the tool as a library, invoked by a wrapper script.

default: True
Whether to tell IPython not to put the CWD on the import path. Normally you want this to be True, so that imports come from the hermetic environment Pants creates. However IPython<7.13.0 doesn't support this option, so if you're using an earlier version (e.g., because you have Python 2.7 code) then you will need to set this to False, and you may have issues with imports from your CWD shading the hermetic environment.

Deprecated options

--ipython-interpreter-constraints="['<str>', '<str>', ...]"
default: []
Deprecated, will be removed in version: 2.1.0.dev0.
This option no longer does anything, as Pants auto-configures the interpreter constraints for ipython based on your code's interpreter constraints.
Python interpreter constraints for this tool. An empty list uses the default interpreter constraints for the repo.

Updated about a month ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.