# LanceDB
A Python library for [LanceDB](https://github.com/lancedb/lancedb).
## Installation
```bash
pip install lancedb
```
## Usage
### Basic Example
```python
import lancedb
db = lancedb.connect('<PATH_TO_LANCEDB_DATASET>')
table = db.open_table('my_table')
results = table.search([0.1, 0.3]).limit(20).to_list()
print(results)
```
## Development
LanceDb is based on the rust crate `lancedb` and is built with maturin. In order to build with maturin
you will either need a conda environment or a virtual environment (venv).
```bash
python -m venv venv
. ./venv/bin/activate
```
Install the necessary packages:
```bash
python -m pip install .[tests,dev]
```
To build the python package you can use maturin:
```bash
# This will build the rust bindings and place them in the appropriate place
# in your venv or conda environment
maturin develop
```
To run the unit tests:
```bash
pytest
```
To run the doc tests:
```bash
pytest --doctest-modules python/lancedb
```
To run linter and automatically fix all errors:
```bash
ruff format python
ruff --fix python
```
If any packages are missing, install them with:
```bash
pip install <PACKAGE_NAME>
```
___
For **Windows** users, there may be errors when installing packages, so these commands may be helpful:
Activate the virtual environment:
```bash
. .\venv\Scripts\activate
```
You may need to run the installs separately:
```bash
pip install -e .[tests]
pip install -e .[dev]
```
`tantivy` requires `rust` to be installed, so install it with `conda`, as it doesn't support windows installation:
```bash
pip install wheel
pip install cargo
conda install rust
pip install tantivy
```
Raw data
{
"_id": null,
"home_page": null,
"name": "lancedb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "data-format, data-science, machine-learning, arrow, data-analytics",
"author": null,
"author_email": "LanceDB Devs <dev@lancedb.com>",
"download_url": null,
"platform": null,
"description": "# LanceDB\n\nA Python library for [LanceDB](https://github.com/lancedb/lancedb).\n\n## Installation\n\n```bash\npip install lancedb\n```\n\n## Usage\n\n### Basic Example\n\n```python\nimport lancedb\ndb = lancedb.connect('<PATH_TO_LANCEDB_DATASET>')\ntable = db.open_table('my_table')\nresults = table.search([0.1, 0.3]).limit(20).to_list()\nprint(results)\n```\n\n## Development\n\nLanceDb is based on the rust crate `lancedb` and is built with maturin. In order to build with maturin\nyou will either need a conda environment or a virtual environment (venv).\n\n```bash\npython -m venv venv\n. ./venv/bin/activate\n```\n\nInstall the necessary packages:\n\n```bash\npython -m pip install .[tests,dev]\n```\n\nTo build the python package you can use maturin:\n\n```bash\n# This will build the rust bindings and place them in the appropriate place\n# in your venv or conda environment\nmaturin develop\n```\n\nTo run the unit tests:\n\n```bash\npytest\n```\n\nTo run the doc tests:\n\n```bash\npytest --doctest-modules python/lancedb\n```\n\nTo run linter and automatically fix all errors:\n\n```bash\nruff format python\nruff --fix python\n```\n\nIf any packages are missing, install them with:\n\n```bash\npip install <PACKAGE_NAME>\n```\n\n___\nFor **Windows** users, there may be errors when installing packages, so these commands may be helpful:\n\nActivate the virtual environment:\n\n```bash\n. .\\venv\\Scripts\\activate\n```\n\nYou may need to run the installs separately:\n\n```bash\npip install -e .[tests]\npip install -e .[dev]\n```\n\n`tantivy` requires `rust` to be installed, so install it with `conda`, as it doesn't support windows installation:\n\n```bash\npip install wheel\npip install cargo\nconda install rust\npip install tantivy\n```\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "lancedb",
"version": "0.6.11",
"project_urls": {
"repository": "https://github.com/lancedb/lancedb"
},
"split_keywords": [
"data-format",
" data-science",
" machine-learning",
" arrow",
" data-analytics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa37b9d684a32bc275bfb57ceeff597c0cf0ebd54825ad4783476fcc003b86c8",
"md5": "629b962b9029a1a20106024a27e80017",
"sha256": "79dbc2a79dac7b843e328a3b7eecb1b42f38ad524742111a38efbeaa1f58ddfe"
},
"downloads": -1,
"filename": "lancedb-0.6.11-cp38-abi3-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "629b962b9029a1a20106024a27e80017",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 18211571,
"upload_time": "2024-04-28T14:28:51",
"upload_time_iso_8601": "2024-04-28T14:28:51.834001Z",
"url": "https://files.pythonhosted.org/packages/fa/37/b9d684a32bc275bfb57ceeff597c0cf0ebd54825ad4783476fcc003b86c8/lancedb-0.6.11-cp38-abi3-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "675bb3b68f269730817f59a460a155a9d1a62c7e6700a8160690541510351da2",
"md5": "8f8454df7c4765abc2119b41b2d11112",
"sha256": "bfc6661e1fe5dd75346b4a1980243b4ccecd2b0ad991f8becc6e506a608c2d8a"
},
"downloads": -1,
"filename": "lancedb-0.6.11-cp38-abi3-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "8f8454df7c4765abc2119b41b2d11112",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 16599063,
"upload_time": "2024-04-28T14:19:51",
"upload_time_iso_8601": "2024-04-28T14:19:51.965549Z",
"url": "https://files.pythonhosted.org/packages/67/5b/b3b68f269730817f59a460a155a9d1a62c7e6700a8160690541510351da2/lancedb-0.6.11-cp38-abi3-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6269bb77ceb9a59ddf44156e2b2c224357276eea5df098a23dd87d3d6bf1a31a",
"md5": "ab1ebad5c50933b3805b1733e38bcd5c",
"sha256": "0998c2dae676c24b95d492358f80ef6e5100b86335b96bf402af3f28f7ec4f3b"
},
"downloads": -1,
"filename": "lancedb-0.6.11-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "ab1ebad5c50933b3805b1733e38bcd5c",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 19019065,
"upload_time": "2024-04-28T14:20:37",
"upload_time_iso_8601": "2024-04-28T14:20:37.569121Z",
"url": "https://files.pythonhosted.org/packages/62/69/bb77ceb9a59ddf44156e2b2c224357276eea5df098a23dd87d3d6bf1a31a/lancedb-0.6.11-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "599e52ebe60a715ba7e1c614b551f34908b224930f56763550efcb6ac9c7c439",
"md5": "c53b549b59d038183b883f183a38eb61",
"sha256": "b6b289599c4c6a61a70da89d4c3201abec7483d0e03573506014af2dcddfe0c4"
},
"downloads": -1,
"filename": "lancedb-0.6.11-cp38-abi3-manylinux_2_24_aarch64.whl",
"has_sig": false,
"md5_digest": "c53b549b59d038183b883f183a38eb61",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 17610043,
"upload_time": "2024-04-28T14:20:37",
"upload_time_iso_8601": "2024-04-28T14:20:37.849213Z",
"url": "https://files.pythonhosted.org/packages/59/9e/52ebe60a715ba7e1c614b551f34908b224930f56763550efcb6ac9c7c439/lancedb-0.6.11-cp38-abi3-manylinux_2_24_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9d1f4192cb739c4d2670a8ae60fd995069421fd3ed3edd7ac7985e4cf2958a2",
"md5": "8c4f9edecaf0a0c3c57c5f6d894fe697",
"sha256": "d789d5a181c4bc42650567cb63ce2772ed902046b08e8e401970df284a4df1c1"
},
"downloads": -1,
"filename": "lancedb-0.6.11-cp38-abi3-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "8c4f9edecaf0a0c3c57c5f6d894fe697",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 19020380,
"upload_time": "2024-04-28T14:19:57",
"upload_time_iso_8601": "2024-04-28T14:19:57.715248Z",
"url": "https://files.pythonhosted.org/packages/c9/d1/f4192cb739c4d2670a8ae60fd995069421fd3ed3edd7ac7985e4cf2958a2/lancedb-0.6.11-cp38-abi3-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3eed2af29d4cb767fb25061c25046751770d69a5eedd83938ca72448689354d0",
"md5": "523e3099a3d38dc4bb6cc0523d21142a",
"sha256": "ea12fc94545afb03933d080cce593491e593ab95cbfddf05ab7183bce2bc8d62"
},
"downloads": -1,
"filename": "lancedb-0.6.11-cp38-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "523e3099a3d38dc4bb6cc0523d21142a",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 19979086,
"upload_time": "2024-04-28T14:31:29",
"upload_time_iso_8601": "2024-04-28T14:31:29.719120Z",
"url": "https://files.pythonhosted.org/packages/3e/ed/2af29d4cb767fb25061c25046751770d69a5eedd83938ca72448689354d0/lancedb-0.6.11-cp38-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 14:28:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lancedb",
"github_project": "lancedb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lancedb"
}
JSON
