def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
"list",
description=descr,
help=descr,
formatter_class=RawDescriptionHelpFormatter,
epilog=examples,
add_help=False,
)
common.add_parser_help(p)
common.add_parser_prefix(p)
common.add_parser_json(p)
common.add_parser_show_channel_urls(p)
p.add_argument(
"-c", "--canonical", action="store_true", help="Output canonical names of packages only. Implies --no-pip. "
)
p.add_argument("-f", "--full-name", action="store_true", help="Only search for full names, i.e., ^<regex>$.")
p.add_argument(
"-e",
"--export",
action="store_true",
help="""Output requirement string only (output may be used by conda create
--file).""",
)
p.add_argument("-r", "--revisions", action="store_true", help="List the revision history and exit.")
p.add_argument(
"--no-pip", action="store_false", default=True, dest="pip", help="Do not include pip-only installed packages."
)
p.add_argument("regex", action="store", nargs="?", help="List only packages matching this regular expression.")
p.set_defaults(func=execute)
def main():
p = ArgumentParser(
description="""
Install a Python package in 'development mode'.
This works by creating a conda.pth file in site-packages."""
# TODO: Use setup.py to determine any entry-points to install.
)
p.add_argument(
'source',
action="store",
metavar='PATH',
nargs='+',
help="Path to the source directory."
)
p.add_argument(
'-npf', '--no-pth-file',
action='store_true',
help=("Relink compiled extension dependencies against "
"libraries found in current conda env. "
"Do not add source to conda.pth."))
add_parser_prefix(p)
p.set_defaults(func=execute)
args = p.parse_args()
args_func(args, p)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'list',
description = descr,
help = descr,
)
common.add_parser_prefix(p)
p.add_argument(
'-c', "--canonical",
action = "store_true",
help = "output canonical names of packages only",
)
p.add_argument(
'-e', "--export",
action = "store_true",
help = "output requirement string only "
"(output may be used by conda create --file)",
)
p.add_argument(
"--no-pip",
action = "store_false",
default=True,
dest="pip",
help = "Do not include pip-only installed packages")
p.add_argument(
'regex',
action = "store",
nargs = "?",
help = "list only packages matching this regular expression",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers, name="remove"):
p = sub_parsers.add_parser(
name,
formatter_class=RawDescriptionHelpFormatter,
description=descr % name,
help=help % name,
epilog=example % name,
)
common.add_parser_yes(p)
common.add_parser_json(p)
p.add_argument("--all", action="store_true", help="%s all packages, i.e. the entire environment" % name)
p.add_argument("--features", action="store_true", help="%s features (instead of packages)" % name)
common.add_parser_no_pin(p)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
common.add_parser_use_index_cache(p)
common.add_parser_use_local(p)
common.add_parser_offline(p)
p.add_argument(
"--force-pscheck",
action="store_true",
help=("force removal (when package process is running)" if config.platform == "win" else argparse.SUPPRESS),
)
p.add_argument(
"package_names",
metavar="package_name",
action="store",
nargs="*",
help="package names to %s from environment" % name,
).completer = common.InstalledPackages
p.set_defaults(func=execute)
def main():
p = argparse.ArgumentParser(
description='tool for inspecting conda packages'
)
subcommand = p.add_subparsers(
dest='subcommand',
)
linkages = subcommand.add_parser(
"linkages",
help="Tools to investigate linkages of binary libraries in a package",
)
linkages.add_argument(
'packages',
action='store',
nargs='+',
help='conda packages to inspect',
)
linkages.add_argument(
'--show-files',
action="store_true",
help="Show the files in the package that link to each library",
)
add_parser_prefix(linkages)
p.set_defaults(func=execute)
args = p.parse_args()
args_func(args, p)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'run',
description=descr,
help=descr,
epilog=examples,
)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
common.add_parser_json(p)
p.add_argument(
'package',
metavar='COMMAND',
action="store",
nargs='?',
help="Package to launch."
)
p.add_argument(
'arguments',
metavar='ARGUMENTS',
action='store',
nargs='*',
help="Additional arguments to application."
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'search',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
epilog = example,
)
common.add_parser_prefix(p)
p.add_argument(
'-c', "--canonical",
action = "store_true",
help = "output canonical names of packages only",
)
p.add_argument(
'-v', "--verbose",
action = "store_true",
help = "Show available packages as blocks of data",
)
p.add_argument(
'regex',
action = "store",
nargs = "?",
help = "package specification or regular expression to search for "
"(default: display all packages)",
)
common.add_parser_channels(p, dashc=False)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'remove',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = help,
epilog = example,
)
common.add_parser_yes(p)
p.add_argument(
"--all",
action = "store_true",
help = "remove all packages, i.e. the entire environment",
)
p.add_argument(
"--features",
action = "store_true",
help = "remove features (instead of packages)",
)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument(
'package_names',
metavar = 'package_name',
action = "store",
nargs = '*',
help = "package names to remove from environment",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'create',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
epilog = example,
)
common.add_parser_yes(p)
p.add_argument(
'-f', "--file",
action = "store",
help = "filename to read package specs from",
)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument(
'package_specs',
metavar = 'package_spec',
action = "store",
nargs = '*',
help = "specification of package to install into new environment",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'search',
description=descr,
help=descr,
epilog=example,
)
common.add_parser_prefix(p)
p.add_argument(
"--canonical",
action="store_true",
help="Output canonical names of packages only.",
)
p.add_argument(
'-f', "--full-name",
action="store_true",
help="Only search for full name, ie. ^<regex>$.",
)
p.add_argument(
"--names-only",
action="store_true",
help="Output only package names.",
)
common.add_parser_known(p)
common.add_parser_use_index_cache(p)
p.add_argument(
'-o', "--outdated",
action="store_true",
help="Only display installed but outdated packages.",
)
p.add_argument(
'--platform',
action='store',
dest='platform',
help="""Search the given platform. Should be formatted like 'osx-64', 'linux-32',
'win-64', and so on. The default is to search the current platform.""",
choices=Platforms(),
default=None,
)
p.add_argument(
"--spec",
action="store_true",
help="""Treat the regex argument as a package specification instead
(package_name[=version[=build]]).""",
)
p.add_argument(
'regex',
metavar='regex',
action="store",
nargs="?",
help="""Package specification or regular expression to search for (default: display
all packages).""",
).completer = common.Packages
common.add_parser_offline(p)
common.add_parser_channels(p)
common.add_parser_json(p)
common.add_parser_use_local(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers, name='remove'):
if name == 'remove':
p = sub_parsers.add_parser(
name,
formatter_class=RawDescriptionHelpFormatter,
description=descr % name.capitalize(),
help=help % name.capitalize(),
epilog=example % name,
add_help=False,
)
else:
p = sub_parsers.add_parser(
name,
formatter_class=RawDescriptionHelpFormatter,
description=uninstall_help,
help=uninstall_help,
epilog=example % name,
add_help=False,
)
common.add_parser_help(p)
common.add_parser_yes(p)
common.add_parser_json(p)
p.add_argument(
"--all",
action="store_true",
help="%s all packages, i.e., the entire environment." % name.capitalize(),
)
p.add_argument(
"--features",
action="store_true",
help="%s features (instead of packages)." % name.capitalize(),
)
p.add_argument(
"--force",
action="store_true",
help="Forces removal of a package without removing packages that depend on it. "
"Using this option will usually leave your environment in a broken and "
"inconsistent state.",
)
common.add_parser_no_pin(p)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
# Putting this one first makes it the default
common.add_parser_no_use_index_cache(p)
common.add_parser_use_index_cache(p)
common.add_parser_use_local(p)
common.add_parser_offline(p)
common.add_parser_pscheck(p)
p.add_argument(
'package_names',
metavar='package_name',
action="store",
nargs='*',
help="Package names to %s from the environment." % name,
).completer = common.InstalledPackages
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'share',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
)
common.add_parser_prefix(p)
common.add_parser_json(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'install',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = help,
epilog = example,
)
common.add_parser_yes(p)
p.add_argument(
'-f', "--force",
action = "store_true",
help = "force install (even when package already installed), "
"implies --no-deps",
)
p.add_argument(
"--file",
action = "store",
help = "read package versions from FILE",
)
p.add_argument(
"--no-deps",
action = "store_true",
help = "do not install dependencies",
)
p.add_argument(
'-m', "--mkdir",
action = "store_true",
help = "create prefix directory if necessary",
)
p.add_argument(
"--no-pip",
action = "store_false",
default=True,
dest="pip",
help = "do not use pip to install if conda fails",
)
p.add_argument(
"--use-local",
action="store_true",
default=False,
dest='use_local',
help = "use locally built packages",
)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument(
'packages',
metavar = 'package_spec',
action = "store",
nargs = '*',
help = "package versions to install into conda environment",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser('package', description=descr, help=descr)
common.add_parser_prefix(p)
p.add_argument(
'-c', "--check",
action = "store_true",
help = "check (validate) the given conda packages (PATH) and exit",
)
p.add_argument(
'-w', "--which",
action = "store_true",
help = "given some PATH print which conda package the file came from",
)
p.add_argument(
'-r', "--reset",
action = "store_true",
help = "remove all untracked files and exit",
)
p.add_argument(
'-u', "--untracked",
action = "store_true",
help = "display all untracked files and exit",
)
p.add_argument(
"--share",
action = "store_true",
help = 'Create a "share package"',
)
p.add_argument(
"--pkg-name",
action = "store",
default = "unknown",
help = "package name of the created package",
)
p.add_argument(
"--pkg-version",
action = "store",
default = "0.0",
help = "package version of the created package",
)
p.add_argument(
"--pkg-build",
action = "store",
default = 0,
help = "package build number of the created package",
)
p.add_argument(
'path',
metavar = 'PATH',
action = "store",
nargs = '*',
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers, name='remove'):
if name == 'remove':
p = sub_parsers.add_parser(
name,
formatter_class=RawDescriptionHelpFormatter,
description=descr % name.capitalize(),
help=help % name.capitalize(),
epilog=example % name,
add_help=False,
)
else:
p = sub_parsers.add_parser(
name,
formatter_class=RawDescriptionHelpFormatter,
description=uninstall_help,
help=uninstall_help,
epilog=example % name,
add_help=False,
)
common.add_parser_help(p)
common.add_parser_yes(p)
common.add_parser_json(p)
p.add_argument(
"--all",
action="store_true",
help="%s all packages, i.e., the entire environment." % name.capitalize(),
)
p.add_argument(
"--features",
action="store_true",
help="%s features (instead of packages)." % name.capitalize(),
)
common.add_parser_no_pin(p)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
common.add_parser_use_index_cache(p)
common.add_parser_use_local(p)
common.add_parser_offline(p)
p.add_argument(
"--force-pscheck",
action="store_true",
help=("Force removal (when package process is running) (deprecated)"
if config.platform == 'win' else argparse.SUPPRESS)
)
p.add_argument(
'package_names',
metavar='package_name',
action="store",
nargs='*',
help="Package names to %s from the environment." % name,
).completer = common.InstalledPackages
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'search',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
epilog = example,
)
common.add_parser_prefix(p)
p.add_argument(
"--canonical",
action = "store_true",
help = "output canonical names of packages only",
)
common.add_parser_known(p)
common.add_parser_use_index_cache(p)
p.add_argument(
'-o', "--outdated",
action = "store_true",
help = "only display installed but outdated packages",
)
p.add_argument(
'-v', "--verbose",
action = "store_true",
help = "Show available packages as blocks of data",
)
p.add_argument(
'--platform',
action='store',
dest='platform',
help="""Search the given platform. Should be formatted like 'osx-64', 'linux-32',
'win-64', and so on. The default is to search the current platform.""",
choices=Platforms(),
default=None,
)
p.add_argument(
"--spec",
action = "store_true",
help = "Treat regex argument as a package specification instead "
"(package_name[=version[=build]])",
)
p.add_argument(
'regex',
action = "store",
nargs = "?",
help = "package specification or regular expression to search for "
"(default: display all packages)",
)
common.add_parser_channels(p)
common.add_parser_json(p)
common.add_parser_use_local(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser('package', description=descr, help=descr)
common.add_parser_prefix(p)
p.add_argument(
'-w', "--which",
action = "store_true",
help = "given some PATH print which conda package the file came from",
)
p.add_argument(
'-L', "--ls-files",
metavar = 'PKG-NAME',
action = "store",
help = "list all files belonging to specified package",
)
p.add_argument(
'-r', "--reset",
action = "store_true",
help = "remove all untracked files and exit",
)
p.add_argument(
'-u', "--untracked",
action = "store_true",
help = "display all untracked files and exit",
)
p.add_argument(
"--pkg-name",
action = "store",
default = "unknown",
help = "package name of the created package",
)
p.add_argument(
"--pkg-version",
action = "store",
default = "0.0",
help = "package version of the created package",
)
p.add_argument(
"--pkg-build",
action = "store",
default = 0,
help = "package build number of the created package",
)
p.add_argument(
'path',
metavar = 'PATH',
action = "store",
nargs = '*',
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'remove',
formatter_class=RawDescriptionHelpFormatter,
description=_description,
help=_help,
epilog=_example,
)
common.add_parser_prefix(p)
common.add_parser_json(p)
common.add_parser_quiet(p)
common.add_parser_yes(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'clone',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
)
p.add_argument(
'path',
metavar = 'PATH',
action = "store",
nargs = 1,
help = 'path to "share package"',
)
common.add_parser_prefix(p)
common.add_parser_json(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
"create", formatter_class=RawDescriptionHelpFormatter, description=descr, help=descr, epilog=example
)
common.add_parser_yes(p)
p.add_argument("-f", "--file", action="store", help="filename to read package specs from")
p.add_argument("--clone", action="store", help='path existing environment or "share package"', metavar="ENV")
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument(
"package_specs",
metavar="package_spec",
action="store",
nargs="*",
help="specification of package to install into new environment",
)
p.set_defaults(func=execute)
def main():
p = ArgumentParser(
description="""
Install a Python package in 'development mode'.
This works by creating a conda.pth file in site-packages."""
# TODO: Use setup.py to determine any entry-points to install.
)
p.add_argument(
'source',
action="store",
metavar='PATH',
nargs='+',
help="Path to the source directory."
)
p.add_argument('-npf', '--no-pth-file',
action='store_true',
help=("Relink compiled extension dependencies against "
"libraries found in current conda env. "
"Do not add source to conda.pth."))
p.add_argument('-b', '--build_ext',
action='store_true',
help=("Build extensions inplace, invoking: "
"python setup.py build_ext --inplace; "
"add to conda.pth; relink runtime libraries to "
"environment's lib/."))
p.add_argument('-c', '--clean',
action='store_true',
help=("Invoke clean on setup.py: "
"python setup.py clean "
"use with build_ext to clean before building."))
p.add_argument('-u', '--uninstall',
action='store_true',
help=("Removes package if installed in 'development mode' "
"by deleting path from conda.pth file. Ignore other "
"options - just uninstall and exit"))
add_parser_prefix(p)
p.set_defaults(func=execute)
args = p.parse_args()
args_func(args, p)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'create',
formatter_class=RawDescriptionHelpFormatter,
description=description,
help=description,
epilog=example,
)
p.add_argument(
'-f', '--file',
action='store',
help='environment definition file (default: environment.yml)',
default='environment.yml',
)
# Add name and prefix args
common.add_parser_prefix(p)
p.add_argument(
'-q', '--quiet',
action='store_true',
default=False,
)
p.add_argument(
'remote_definition',
help='remote environment definition / IPython notebook',
action='store',
default=None,
nargs='?'
)
p.add_argument(
'--force',
help='force creation of environment (removing a previously existing environment of the same name).',
action='store_true',
default=False,
)
p.add_argument(
'--select',
action='append',
help="toggle preprocessing selectors. pass multiple times to toggle multiple selectors. pass 'all' to toggle all selectors",
metavar="SELECTORS",
)
common.add_parser_json(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'bundle',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
)
cxgroup = p.add_mutually_exclusive_group()
cxgroup.add_argument('-c', "--create",
action = "store_true",
help = "create bundle")
cxgroup.add_argument('-x', "--extract",
action = "store",
help = "extact bundle located at PATH",
metavar = "PATH")
cxgroup.add_argument("--metadump",
action = "store",
help = "dump metadata of bundle at PATH",
metavar = "PATH")
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument("--bundle-name",
action = "store",
help = "name of bundle",
metavar = 'NAME',
)
p.add_argument("--data-path",
action = "store",
help = "path to data to be included in bundle",
metavar = "PATH"
)
p.add_argument("--extra-meta",
action = "store",
help = "path to json file with additional meta-data",
metavar = "PATH",
)
p.add_argument("--no-env",
action = "store_true",
help = "no environment",
)
common.add_parser_json(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'list',
description = "List linked packages in a conda environment.",
help = "List linked packages in a conda environment.",
)
common.add_parser_prefix(p)
p.add_argument(
'-c', "--canonical",
action = "store_true",
help = "output canonical names of packages only",
)
p.add_argument(
'regex',
action = "store",
nargs = "?",
help = "list only packages matching this regular expression",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'package',
description=descr,
help=descr,
)
common.add_parser_prefix(p)
p.add_argument(
'-w', "--which",
metavar="PATH",
nargs='+',
action="store",
help="Given some PATH print which conda package the file came from.",
)
p.add_argument(
'-r', "--reset",
action="store_true",
help="Remove all untracked files and exit.",
)
p.add_argument(
'-u', "--untracked",
action="store_true",
help="Display all untracked files and exit.",
)
p.add_argument(
"--pkg-name",
action="store",
default="unknown",
help="Package name of the created package.",
)
p.add_argument(
"--pkg-version",
action="store",
default="0.0",
help="Package version of the created package.",
)
p.add_argument(
"--pkg-build",
action="store",
default=0,
help="Package build number of the created package.",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'update',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
epilog = example,
)
common.add_parser_yes(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument(
'pkg_names',
metavar = 'package_name',
action = "store",
nargs = '*',
help = "names of packages to update",
)
common.add_parser_channels(p)
p.set_defaults(func=execute)
def main():
p = argparse.ArgumentParser(
description="""Install a Python package in 'development mode'.
This works by creating a conda.pth file in site-packages, and using
setup.py to determine any entry-points to install."""
)
p.add_argument(
'source',
action="store",
metavar='PATH',
nargs='+',
help="path to the source directory"
)
add_parser_prefix(p)
p.set_defaults(func=execute)
args = p.parse_args()
args_func(args, p)
def configure_parser():
p = ArgumentParser(
'analysispackage',
description="analysis package",
)
cxgroup = p.add_mutually_exclusive_group()
cxgroup.add_argument('-c', "--create",
action = "store_true",
help = "create analysis package")
cxgroup.add_argument('-x', "--extract",
action = "store",
help = "extact analysis package located at PATH",
metavar = "PATH")
cxgroup.add_argument("--metadump",
action = "store",
help = "dump metadata of analysis package at PATH",
metavar = "PATH")
common.add_parser_prefix(p)
common.add_parser_quiet(p)
p.add_argument("--analysispackage-name",
action = "store",
help = "name of analysis package",
metavar = 'NAME',
)
p.add_argument("--data-path",
action = "store",
help = "path to data to be included in analysis package",
metavar = "PATH",
)
p.add_argument("--extra-meta",
action = "store",
help = "path to json file with additional meta-data no",
metavar = "PATH",
)
p.add_argument("--no-env",
action = "store_true",
help = "no environment",
)
common.add_parser_json(p)
p.set_defaults(func=execute)
return p
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'remove',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = help,
epilog = example,
)
common.add_parser_yes(p)
common.add_parser_json(p)
p.add_argument(
"--all",
action = "store_true",
help = "remove all packages, i.e. the entire environment",
)
p.add_argument(
"--features",
action = "store_true",
help = "remove features (instead of packages)",
)
common.add_parser_no_pin(p)
common.add_parser_channels(p)
common.add_parser_prefix(p)
common.add_parser_quiet(p)
common.add_parser_use_index_cache(p)
common.add_parser_use_local(p)
p.add_argument(
"--force-pscheck",
action = "store_true",
help = ("force removal (when package process is running)"
if config.platform == 'win' else argparse.SUPPRESS)
)
p.add_argument(
'package_names',
metavar = 'package_name',
action = "store",
nargs = '*',
help = "package names to remove from environment",
)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser('package', description=descr, help=descr)
common.add_parser_prefix(p)
p.add_argument(
'-c', "--check",
action = "store",
help = "check (validate) the given tar package and exit",
metavar = 'PATH',
)
p.add_argument(
'-r', "--reset",
action = "store_true",
help = "remove all untracked files and exit",
)
p.add_argument(
'-u', "--untracked",
action = "store_true",
help = "display all untracked files and exit",
)
p.add_argument(
"--pkg-name",
action = "store",
default = "unknown",
help = "package name of the created package",
)
p.add_argument(
"--pkg-version",
action = "store",
default = "0.0",
help = "package version of the created package",
)
p.add_argument(
"--pkg-build",
action = "store",
default = 0,
help = "package build number of the created package",
)
p.set_defaults(func=execute)
def main():
p = argparse.ArgumentParser(
description='Tools for inspecting conda packages')
subcommand = p.add_subparsers(dest='subcommand', )
linkages_help = """
Investigate linkages of binary libraries in a package (only works in Linux
and OS X). Aggregates the output of ldd (on Linux) and otool -L (on OS
X). Useful for finding broken links, or links against system libraries
that ought to be dependent conda packages."""
linkages = subcommand.add_parser(
"linkages",
# help controls conda inspect -h and description controls conda
# inspect linkages -h
help=linkages_help,
description=linkages_help,
)
linkages.add_argument(
'packages',
action='store',
nargs='*',
help='conda packages to inspect',
)
linkages.add_argument(
'--untracked',
action='store_true',
help="""Inspect the untracked files in the environment. Useful when used
in conjunction with conda build --build-only.""",
)
linkages.add_argument(
'--show-files',
action="store_true",
help="Show the files in the package that link to each library",
)
add_parser_prefix(linkages)
objects_help = """Investigate binary object files in a package (only works
in OS X). Aggregates the output of otool on all the binary object files in
a package."""
objects = subcommand.add_parser(
"objects",
help=objects_help,
description=objects_help,
)
objects.add_argument(
'packages',
action='store',
nargs='*',
help='conda packages to inspect',
)
objects.add_argument(
'--untracked',
action='store_true',
help="""Inspect the untracked files in the environment. Useful when used
in conjunction with conda build --build-only.""",
)
objects.add_argument(
'--groupby',
action='store',
default='filename',
choices={'filename', 'filetype', 'rpath'},
help='Attribute to group by (default: %(default)s)',
)
add_parser_prefix(objects)
p.set_defaults(func=execute)
args = p.parse_args()
args_func(args, p)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'search',
formatter_class = RawDescriptionHelpFormatter,
description = descr,
help = descr,
epilog = example,
)
common.add_parser_prefix(p)
p.add_argument(
"--canonical",
action = "store_true",
help = "output canonical names of packages only",
)
p.add_argument(
'-f', "--full-name",
action = "store_true",
help = "only search for full name, ie. ^<regex>$",
)
p.add_argument(
"--names-only",
action = "store_true",
help = "output only package names",
)
common.add_parser_known(p)
common.add_parser_use_index_cache(p)
p.add_argument(
'-o', "--outdated",
action = "store_true",
help = "only display installed but outdated packages",
)
p.add_argument(
'-v', "--verbose",
action = "store_true",
help = "Show available packages as blocks of data",
)
p.add_argument(
'--platform',
action='store',
dest='platform',
help="""Search the given platform. Should be formatted like 'osx-64', 'linux-32',
'win-64', and so on. The default is to search the current platform.""",
choices=Platforms(),
default=None,
)
p.add_argument(
"--spec",
action = "store_true",
help = "Treat regex argument as a package specification instead "
"(package_name[=version[=build]])",
)
p.add_argument(
'regex',
metavar = 'regex',
action = "store",
nargs = "?",
help = "package specification or regular expression to search for "
"(default: display all packages)",
).completer = common.Packages
common.add_parser_offline(p)
common.add_parser_channels(p)
common.add_parser_json(p)
common.add_parser_use_local(p)
p.set_defaults(func=execute)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'search',
description=descr,
help=descr,
epilog=example,
)
common.add_parser_prefix(p)
p.add_argument(
"--canonical",
action="store_true",
help="Output canonical names of packages only.",
)
p.add_argument(
'-f',
"--full-name",
action="store_true",
help="Only search for full name, ie. ^<regex>$.",
)
p.add_argument(
"--names-only",
action="store_true",
help="Output only package names.",
)
common.add_parser_known(p)
common.add_parser_use_index_cache(p)
p.add_argument(
'-o',
"--outdated",
action="store_true",
help="Only display installed but outdated packages.",
)
p.add_argument(
'--platform',
action='store',
dest='platform',
help=
"""Search the given platform. Should be formatted like 'osx-64', 'linux-32',
'win-64', and so on. The default is to search the current platform.""",
choices=Platforms(),
default=None,
)
p.add_argument(
"--spec",
action="store_true",
help="""Treat the regex argument as a package specification instead
(package_name[=version[=build]]).""",
)
p.add_argument(
"--reverse-dependency",
action="store_true",
help=
"""Perform a reverse dependency search. When using this flag, the --full-name
flag is recommended. Use 'conda info package' to see the dependencies of a
package.""",
)
p.add_argument(
'regex',
metavar='regex',
action="store",
nargs="?",
help=
"""Package specification or Python regular expression to search for (default: display
all packages).""",
).completer = common.Packages
common.add_parser_offline(p)
common.add_parser_channels(p)
common.add_parser_json(p)
common.add_parser_use_local(p)
p.set_defaults(func=execute)
def main():
p = ArgumentParser(
description='Tools for inspecting conda packages.',
epilog="""
Run --help on the subcommands like 'conda inspect linkages --help' to see the
options available.
""",
)
subcommand = p.add_subparsers(dest='subcommand', )
linkages_help = """
Investigates linkages of binary libraries in a package (works in Linux and
OS X). This is an advanced command to aid building packages that link against
C libraries. Aggregates the output of ldd (on Linux) and otool -L (on OS X) by
dependent packages. Useful for finding broken links, or links against system
libraries that ought to be dependent conda packages. """
linkages = subcommand.add_parser(
"linkages",
# help controls conda inspect -h and description controls conda
# inspect linkages -h
help=linkages_help,
description=linkages_help,
)
linkages.add_argument(
'packages',
action='store',
nargs='*',
help='Conda packages to inspect.',
)
linkages.add_argument(
'--untracked',
action='store_true',
help=
"""Inspect the untracked files in the environment. This is useful when used in
conjunction with conda build --build-only.""",
)
linkages.add_argument(
'--show-files',
action="store_true",
help="Show the files in the package that link to each library",
)
linkages.add_argument(
'--groupby',
action='store',
default='package',
choices=('package', 'dependency'),
help="""Attribute to group by (default: %(default)s). Useful when used
in conjunction with --all.""",
)
linkages.add_argument(
'--all',
action='store_true',
help="Generate a report for all packages in the environment.",
)
add_parser_prefix(linkages)
objects_help = """
Investigate binary object files in a package (only works on OS X). This is an
advanced command to aid building packages that have compiled
libraries. Aggregates the output of otool on all the binary object files in a
package.
"""
objects = subcommand.add_parser(
"objects",
help=objects_help,
description=objects_help,
)
objects.add_argument(
'packages',
action='store',
nargs='*',
help='Conda packages to inspect.',
)
objects.add_argument(
'--untracked',
action='store_true',
help=
"""Inspect the untracked files in the environment. This is useful when used
in conjunction with conda build --build-only.""",
)
# TODO: Allow groupby to include the package (like for --all)
objects.add_argument(
'--groupby',
action='store',
default='filename',
choices=('filename', 'filetype', 'rpath'),
help='Attribute to group by (default: %(default)s).',
)
objects.add_argument(
'--all',
action='store_true',
help="Generate a report for all packages in the environment.",
)
add_parser_prefix(objects)
p.set_defaults(func=execute)
args = p.parse_args()
args_func(args, p)
def configure_parser(sub_parsers):
p = sub_parsers.add_parser(
'list',
description=descr,
help=descr,
formatter_class=RawDescriptionHelpFormatter,
epilog=examples,
add_help=False,
)
common.add_parser_help(p)
common.add_parser_prefix(p)
common.add_parser_json(p)
common.add_parser_show_channel_urls(p)
p.add_argument(
'-c',
"--canonical",
action="store_true",
help="Output canonical names of packages only. Implies --no-pip. ",
)
p.add_argument(
'-f',
"--full-name",
action="store_true",
help="Only search for full names, i.e., ^<regex>$.",
)
p.add_argument(
"--explicit",
action="store_true",
help="List explicitly all installed conda packaged with URL "
"(output may be used by conda create --file).",
)
p.add_argument(
"--md5",
action="store_true",
help="Add MD5 hashsum when using --explicit",
)
p.add_argument(
'-e',
"--export",
action="store_true",
help="Output requirement string only (output may be used by "
" conda create --file).",
)
p.add_argument(
'-r',
"--revisions",
action="store_true",
help="List the revision history and exit.",
)
p.add_argument("--no-pip",
action="store_false",
default=True,
dest="pip",
help="Do not include pip-only installed packages.")
p.add_argument(
'regex',
action="store",
nargs="?",
help="List only packages matching this regular expression.",
)
p.set_defaults(func=execute)
