# Bitbucket Loader
```bash
pip install llama-index-readers-bitbucket
```
This loader utilizes the Bitbucket API to load the files inside a Bitbucket repository as Documents in an index.
## Usage
To use this loader, you need to provide as environment variables the `BITBUCKET_API_KEY` and the `BITBUCKET_USERNAME`.
```python
import os
from llama_index.core import VectorStoreIndex, download_loader
os.environ["BITBUCKET_USERNAME"] = "myusername"
os.environ["BITBUCKET_API_KEY"] = "myapikey"
base_url = "https://myserver/bitbucket"
project_key = "mykey"
from llama_index.readers.bitbucket import BitbucketReader
loader = BitbucketReader(
base_url=base_url,
project_key=project_key,
branch="refs/heads/develop",
repository="ms-messaging",
)
documents = loader.load_data()
index = VectorStoreIndex.from_documents(documents)
```
This loader is designed to be used as a way to load data into [Llama Index](https://github.com/run-llama/llama_index/).
For a step-by-step guide, checkout this [tutorial](https://lejdiprifti.com/2023/12/16/ask-your-bitbucket-rag-with-llamaindex-and-bitbucket/)
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-bitbucket",
"maintainer": "lejdiprifti",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": "bitbucket, project, repository",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/0c/a7/5ef7723b9798abfb8a4f9429cd5571b1a1a6fc021f4ddf6581e80a318796/llama_index_readers_bitbucket-0.2.0.tar.gz",
"platform": null,
"description": "# Bitbucket Loader\n\n```bash\npip install llama-index-readers-bitbucket\n```\n\nThis loader utilizes the Bitbucket API to load the files inside a Bitbucket repository as Documents in an index.\n\n## Usage\n\nTo use this loader, you need to provide as environment variables the `BITBUCKET_API_KEY` and the `BITBUCKET_USERNAME`.\n\n```python\nimport os\nfrom llama_index.core import VectorStoreIndex, download_loader\n\nos.environ[\"BITBUCKET_USERNAME\"] = \"myusername\"\nos.environ[\"BITBUCKET_API_KEY\"] = \"myapikey\"\n\nbase_url = \"https://myserver/bitbucket\"\nproject_key = \"mykey\"\n\nfrom llama_index.readers.bitbucket import BitbucketReader\n\nloader = BitbucketReader(\n base_url=base_url,\n project_key=project_key,\n branch=\"refs/heads/develop\",\n repository=\"ms-messaging\",\n)\ndocuments = loader.load_data()\n\nindex = VectorStoreIndex.from_documents(documents)\n```\n\nThis loader is designed to be used as a way to load data into [Llama Index](https://github.com/run-llama/llama_index/).\n\nFor a step-by-step guide, checkout this [tutorial](https://lejdiprifti.com/2023/12/16/ask-your-bitbucket-rag-with-llamaindex-and-bitbucket/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers bitbucket integration",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [
"bitbucket",
" project",
" repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b322a39a0b64231f620f589c2fe11e2595562f58335fde8fc7f476c472042c23",
"md5": "a2e532227aa2b00aa93b223e8da19a7f",
"sha256": "d1053c5a381c71460c85646b5742cbcef2b948d769923271f94311512cd5703e"
},
"downloads": -1,
"filename": "llama_index_readers_bitbucket-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2e532227aa2b00aa93b223e8da19a7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3552,
"upload_time": "2024-08-22T05:54:11",
"upload_time_iso_8601": "2024-08-22T05:54:11.655972Z",
"url": "https://files.pythonhosted.org/packages/b3/22/a39a0b64231f620f589c2fe11e2595562f58335fde8fc7f476c472042c23/llama_index_readers_bitbucket-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ca75ef7723b9798abfb8a4f9429cd5571b1a1a6fc021f4ddf6581e80a318796",
"md5": "f7e342c7ddbbb8b02c32f1cf6e014b3e",
"sha256": "ea034f31fd3669ca2dcfaa28b3ce0d02546c7c9eff1b0bf89b72d4e88caec6de"
},
"downloads": -1,
"filename": "llama_index_readers_bitbucket-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f7e342c7ddbbb8b02c32f1cf6e014b3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 3270,
"upload_time": "2024-08-22T05:54:12",
"upload_time_iso_8601": "2024-08-22T05:54:12.878662Z",
"url": "https://files.pythonhosted.org/packages/0c/a7/5ef7723b9798abfb8a4f9429cd5571b1a1a6fc021f4ddf6581e80a318796/llama_index_readers_bitbucket-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 05:54:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-bitbucket"
}
JSON