**Note**
**Databricks recommends that you use newer Databricks CLI versions 0.200 and above instead of legacy Databricks CLI versions 0.17 and below (located in this repository). You can find the new CLI at https://github.com/databricks/cli.**
**If you have been using the code in this repository as a Python SDK for interacting with the Databricks APIs, we recommend you use the new dedicated SDK package that can be found at https://github.com/databricks/databricks-sdk-py.**
databricks-cli
==============
.. image:: https://github.com/databricks/databricks-cli/actions/workflows/push.yml/badge.svg?branch=main
:target: https://github.com/databricks/databricks-cli/actions/workflows/push.yml?query=branch%main
:alt: Build status
.. image:: https://codecov.io/gh/databricks/databricks-cli/branch/main/graph/badge.svg
:target: https://codecov.io/gh/databricks/databricks-cli
The Databricks Command Line Interface (CLI) is an open source tool which provides an easy to use interface to
the Databricks platform. The CLI is built on top of the Databricks REST APIs.
**Note**: This CLI is no longer under active development and has been released as an experimental client.
Please leave bug reports as issues on our `GitHub project <https://github.com/databricks/databricks-cli>`_.
Requirements
------------
- Python Version >= 3.7
Installation
---------------
To install simply run
``pip install --upgrade databricks-cli``
Then set up authentication using username/password or `authentication token <https://docs.databricks.com/api/latest/authentication.html#token-management>`_. Credentials are stored at ``~/.databrickscfg``.
- ``databricks configure`` (enter hostname/username/password at prompt)
- ``databricks configure --token`` (enter hostname/auth-token at prompt)
Multiple connection profiles are also supported with ``databricks configure --profile <profile> [--token]``.
The connection profile can be used as such: ``databricks workspace ls --profile <profile>``.
To test that your authentication information is working, try a quick test like ``databricks workspace ls``.
Known Issues
---------------
``AttributeError: 'module' object has no attribute 'PROTOCOL_TLSv1_2'``
The Databricks web service requires clients speak TLSV1.2. The built in
version of Python for MacOS does not have this version of TLS built in.
To use the Databricks CLI you must install a version of Python that has ``ssl.PROTOCOL_TLSv1_2``.
For MacOS, the easiest way may be to install Python with `Homebrew <https://brew.sh/>`_.
Using Docker
------------
.. code::
# build image
docker build -t databricks-cli .
# run container
docker run -it databricks-cli
# run command in docker
docker run -it databricks-cli fs --help
Documentation
-------------
For the latest CLI documentation, see
- `Databricks <https://docs.databricks.com/user-guide/dev-tools/databricks-cli.html>`_
- `Azure Databricks <https://learn.microsoft.com/en-us/azure/databricks/dev-tools/cli>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/databricks/databricks-cli",
"name": "databricks-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "databricks cli",
"author": "Andrew Chen",
"author_email": "andrewchen@databricks.com",
"download_url": "https://files.pythonhosted.org/packages/c7/6c/ee7a98f22ba6e4d39cdf7f3a7cd9461fcc562625ccbca58d94bf35fe598b/databricks-cli-0.18.0.tar.gz",
"platform": null,
"description": " **Note**\n\n **Databricks recommends that you use newer Databricks CLI versions 0.200 and above instead of legacy Databricks CLI versions 0.17 and below (located in this repository). You can find the new CLI at https://github.com/databricks/cli.**\n\n **If you have been using the code in this repository as a Python SDK for interacting with the Databricks APIs, we recommend you use the new dedicated SDK package that can be found at https://github.com/databricks/databricks-sdk-py.**\n\ndatabricks-cli\n==============\n.. image:: https://github.com/databricks/databricks-cli/actions/workflows/push.yml/badge.svg?branch=main\n :target: https://github.com/databricks/databricks-cli/actions/workflows/push.yml?query=branch%main\n :alt: Build status\n.. image:: https://codecov.io/gh/databricks/databricks-cli/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/databricks/databricks-cli\n\n\nThe Databricks Command Line Interface (CLI) is an open source tool which provides an easy to use interface to\nthe Databricks platform. The CLI is built on top of the Databricks REST APIs.\n\n**Note**: This CLI is no longer under active development and has been released as an experimental client.\n\nPlease leave bug reports as issues on our `GitHub project <https://github.com/databricks/databricks-cli>`_.\n\nRequirements\n------------\n\n- Python Version >= 3.7\n\nInstallation\n---------------\n\nTo install simply run\n``pip install --upgrade databricks-cli``\n\nThen set up authentication using username/password or `authentication token <https://docs.databricks.com/api/latest/authentication.html#token-management>`_. Credentials are stored at ``~/.databrickscfg``.\n\n- ``databricks configure`` (enter hostname/username/password at prompt)\n- ``databricks configure --token`` (enter hostname/auth-token at prompt)\n\nMultiple connection profiles are also supported with ``databricks configure --profile <profile> [--token]``.\nThe connection profile can be used as such: ``databricks workspace ls --profile <profile>``.\n\nTo test that your authentication information is working, try a quick test like ``databricks workspace ls``.\n\nKnown Issues\n---------------\n``AttributeError: 'module' object has no attribute 'PROTOCOL_TLSv1_2'``\n\nThe Databricks web service requires clients speak TLSV1.2. The built in\nversion of Python for MacOS does not have this version of TLS built in.\n\nTo use the Databricks CLI you must install a version of Python that has ``ssl.PROTOCOL_TLSv1_2``.\nFor MacOS, the easiest way may be to install Python with `Homebrew <https://brew.sh/>`_.\n\nUsing Docker\n------------\n.. code::\n\n # build image\n docker build -t databricks-cli .\n\n # run container\n docker run -it databricks-cli\n\n # run command in docker\n docker run -it databricks-cli fs --help\n\nDocumentation\n-------------\n\nFor the latest CLI documentation, see\n\n- `Databricks <https://docs.databricks.com/user-guide/dev-tools/databricks-cli.html>`_\n- `Azure Databricks <https://learn.microsoft.com/en-us/azure/databricks/dev-tools/cli>`_\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A command line interface for Databricks",
"version": "0.18.0",
"project_urls": {
"Homepage": "https://github.com/databricks/databricks-cli"
},
"split_keywords": [
"databricks",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aea3d56f8382c40899301f327d1c881278b09c9b8bc301c2c111633a0346d06e",
"md5": "c5bdc2e6711f01b4faab51b886b4b0ad",
"sha256": "1176a5f42d3e8af4abfc915446fb23abc44513e325c436725f5898cbb9e3384b"
},
"downloads": -1,
"filename": "databricks_cli-0.18.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5bdc2e6711f01b4faab51b886b4b0ad",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 150329,
"upload_time": "2023-10-05T09:36:25",
"upload_time_iso_8601": "2023-10-05T09:36:25.745004Z",
"url": "https://files.pythonhosted.org/packages/ae/a3/d56f8382c40899301f327d1c881278b09c9b8bc301c2c111633a0346d06e/databricks_cli-0.18.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c76cee7a98f22ba6e4d39cdf7f3a7cd9461fcc562625ccbca58d94bf35fe598b",
"md5": "d0c172a3f4c98a39cfd5a24608681340",
"sha256": "87569709eda9af3e9db8047b691e420b5e980c62ef01675575c0d2b9b4211eb7"
},
"downloads": -1,
"filename": "databricks-cli-0.18.0.tar.gz",
"has_sig": false,
"md5_digest": "d0c172a3f4c98a39cfd5a24608681340",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 95375,
"upload_time": "2023-10-05T09:36:27",
"upload_time_iso_8601": "2023-10-05T09:36:27.750767Z",
"url": "https://files.pythonhosted.org/packages/c7/6c/ee7a98f22ba6e4d39cdf7f3a7cd9461fcc562625ccbca58d94bf35fe598b/databricks-cli-0.18.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 09:36:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "databricks",
"github_project": "databricks-cli",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
">=",
"7.0"
]
]
},
{
"name": "pyjwt",
"specs": [
[
">=",
"1.7.0"
]
]
},
{
"name": "oauthlib",
"specs": [
[
">=",
"3.1.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.17.3"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.7.7"
]
]
},
{
"name": "six",
"specs": [
[
">=",
"1.10.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.26.7"
],
[
"<",
"3"
]
]
}
],
"tox": true,
"lcname": "databricks-cli"
}
JSON
