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

buildsense

Configuration for Toolchain's BuildSense reporting.

Config section: [buildsense]

Basic options

dry_run

--[no-]buildsense-dry-run
PANTS_BUILDSENSE_DRY_RUN
default: False

Go thru the motions w/o making network calls


enable

--[no-]buildsense-enable
PANTS_BUILDSENSE_ENABLE
default: False

Enables the BuildSense reporter plugin


Advanced options

base_url

--buildsense-base-url=<str>
PANTS_BUILDSENSE_BASE_URL
default: https://app.toolchain.com/api/v1/repos/

Where to make HTTP requests to


timeout

--buildsense-timeout=<int>
PANTS_BUILDSENSE_TIMEOUT
default: 5

Wait at most this many seconds for network calls to complete.


local_build_store

--[no-]buildsense-local-build-store
PANTS_BUILDSENSE_LOCAL_BUILD_STORE
default: True

Store failed uploads and try to upload later.


local_store_base

--buildsense-local-store-base=<optional_dir_option>
PANTS_BUILDSENSE_LOCAL_STORE_BASE
default: .pants.d/toolchain/buildsense

Base direcory for storing buildsense data locally


max_batch_size_mb

--buildsense-max-batch-size-mb=<int>
PANTS_BUILDSENSE_MAX_BATCH_SIZE_MB
default: 20

Maximum batch size to try and upload (uncompressed).


ci_env_var_pattern

--buildsense-ci-env-var-pattern=<str>
PANTS_BUILDSENSE_CI_ENV_VAR_PATTERN
default: None

CI Environment variables regex pattern.


log_upload

--[no-]buildsense-log-upload
PANTS_BUILDSENSE_LOG_UPLOAD
default: True

Upload pants logs to buildsense


Deprecated options

None

Updated 15 days ago


buildsense


Suggested Edits are limited on API Reference Pages

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