Skip to main content
Version: 2.16 (deprecated)

export

pants export [args]

Export Pants data for use in other tools, such as IDEs.

Backend: pants.core

Config section: [export]

Basic options​

py_resolve_format​

--export-py-resolve-format=<PythonResolveExportFormat>
PANTS_EXPORT_PY_RESOLVE_FORMAT
pants.toml
[export]
py_resolve_format = <PythonResolveExportFormat>
one of: mutable_virtualenv, symlinked_immutable_virtualenv
default: mutable_virtualenv

Export Python resolves using this format. Options are:

  • mutable_virtualenv: Export a standalone mutable virtualenv that you can further modify.
  • symlinked_immutable_virtualenv: Export a symlink into a cached Python virtualenv. This virtualenv will have no pip binary, and will be immutable. Any attempt to modify it will corrupt the cache! It may, however, take significantly less time to export than a standalone, mutable virtualenv.

resolve​

--export-resolve="['<str>', '<str>', ...]"
PANTS_EXPORT_RESOLVE
pants.toml
[export]
resolve = [
    '<str>',
    '<str>',
    ...,
]
default: []

Export the specified resolve(s). The export format is backend-specific, e.g., Python resolves are exported as virtualenvs.

Advanced options​

None

Deprecated options​

--[no-]export-symlink-python-virtualenv
PANTS_EXPORT_SYMLINK_PYTHON_VIRTUALENV
pants.toml
[export]
symlink_python_virtualenv = <bool>
default: False
Deprecated, will be removed in version: 2.20.0.dev0.
Set the `[export].py_resolve_format` option to 'symlinked_immutable_virtualenv'

Export a symlink into a cached Python virtualenv. This virtualenv will have no pip binary, and will be immutable. Any attempt to modify it will corrupt the cache! It may, however, take significantly less time to export than a standalone, mutable virtualenv will.