{"id":4488,"library":"curatorbin","title":"Curator CLI Wrapper","description":"curatorbin is a Python package that simplifies the installation and execution of the Elasticsearch Curator command-line interface. It downloads the `curator` binary during package installation and provides a Python interface to run its commands. The current version is 1.2.4, with releases typically aligned with updates of the underlying Curator binary or specific wrapper improvements.","status":"active","version":"1.2.4","language":"python","source_language":"en","source_url":"https://github.com/evergreen-ci/curatorbin","tags":["cli","wrapper","elasticsearch","curator","automation"],"install":[{"cmd":"pip install curatorbin","lang":"bash","label":"Install `curatorbin`"}],"dependencies":[],"imports":[{"wrong":"from curatorbin import run_curator_command","symbol":"run_curator","correct":"from curatorbin import run_curator"},{"symbol":"OSPlatform","correct":"from curatorbin import OSPlatform"},{"symbol":"get_curator_path","correct":"from curatorbin import get_curator_path"}],"quickstart":{"code":"from curatorbin import run_curator_command\n\n# Example 1: Check the version of the underlying Curator binary\ntry:\n    stdout, stderr, exit_code = run_curator_command('--version')\n    print(f\"Curator Version (stdout):\\n{stdout.strip()}\")\n    if stderr:\n        print(f\"Curator Version (stderr):\\n{stderr.strip()}\")\n    if exit_code != 0:\n        print(f\"Command '--version' failed with exit code {exit_code}\")\n\n    # Example 2: Display Curator's help message (first few lines)\n    stdout, stderr, exit_code = run_curator_command('--help')\n    print(\"\\nCurator Help (first 10 lines):\\n\" + \"\\n\".join(stdout.splitlines()[:10]))\n\nexcept Exception as e:\n    print(f\"An error occurred during Curator command execution: {e}\")","lang":"python","description":"Demonstrates how to import and use `run_curator_command` to execute arbitrary Curator CLI commands. This function returns the stdout, stderr, and exit code from the underlying binary execution."},"warnings":[{"fix":"Understand that `curatorbin` primarily executes `curator` CLI commands. Use `run_curator_command` to pass arguments as strings, similar to how you'd use the command line.","message":"curatorbin is a Python wrapper for the external `curator` command-line interface, not a pure Python client library for interacting with Elasticsearch. If you need to manage Elasticsearch indices programmatically with Python objects, consider using the `elasticsearch-py` library directly.","severity":"gotcha","affected_versions":"All"},{"fix":"Ensure the system has stable internet connectivity and the user executing `pip install` has permissions to download and create executable files. Check the installation logs for specific error messages.","message":"During `pip install curatorbin`, the package attempts to download the `curator` binary from `https://download.elastic.co`. This process requires network access and appropriate file system permissions. Installation may fail or be slow if these conditions are not met.","severity":"gotcha","affected_versions":"All"},{"fix":"When using `curatorbin` programmatically, always use `curatorbin.run_curator_command()` or the specific `curator` entry point installed by the package to ensure the correct binary is invoked. Avoid relying on simply calling `curator` if your PATH might contain other versions.","message":"If another `curator` executable is already present in your system's PATH, there's a potential for conflict. `curatorbin` aims to use its managed binary, but relying on global PATH settings can lead to unexpected behavior if not carefully managed.","severity":"gotcha","affected_versions":"All"}],"env_vars":null,"search_vec":"'1.2.4':44 'align':48 'autom':64 'binari':27,55 'cli':2,60 'command':20,39 'command-lin':19 'curat':1,18,26,54,63 'curatorbin':4 'current':41 'download':24 'elasticsearch':17,62 'execut':14 'improv':59 'instal':12,30 'interfac':22,35 'line':21 'packag':8,29 'provid':32 'python':7,34 'releas':46 'run':37 'simplifi':10 'specif':57 'typic':47 'under':53 'updat':50 'version':42 'wrapper':3,58,61","created_at":"2026-04-12T13:54:48.189749+00:00","updated_at":"2026-04-16T04:30:13.126491+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"1.2.4","cli_name":"curator","cli_version":"sh: 1: curator: not found","type":"library","homepage":null,"github":"https://github.com/evergreen-ci/curatorbin","docs":null,"changelog":null,"pypi":"https://pypi.org/project/curatorbin/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops","database"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-30","last_verified":"2026-08-29","next_check":"2026-07-30","install_tag":null}}