Pants v2: The ergonomic build system

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable, user-friendly 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 (https://ipython.org/).

Config section: [ipython]

Basic options

None

Advanced options

version

--ipython-version=<str>
PANTS_IPYTHON_VERSION
default: ipython==7.16.1

Requirement string for the tool.


extra_requirements

--ipython-extra-requirements="['<str>', '<str>', ...]"
PANTS_IPYTHON_EXTRA_REQUIREMENTS
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.


console_script

--ipython-console-script=<str>
PANTS_IPYTHON_CONSOLE_SCRIPT
default: ipython

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.


entry_point

--ipython-entry-point=<str>
PANTS_IPYTHON_ENTRY_POINT
default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.


ignore_cwd

--[no-]ipython-ignore-cwd
PANTS_IPYTHON_IGNORE_CWD
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

None

Updated about a month ago


ipython


Suggested Edits are limited on API Reference Pages

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