# Bitbucket Loader
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 import VectorStoreIndex, download_loader
os.environ["BITBUCKET_USERNAME"] = "myusername"
os.environ["BITBUCKET_API_KEY"] = "myapikey"
base_url = "https://myserver/bitbucket"
project_key = "mykey"
BitbucketReader = download_loader("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/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.
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": "",
"name": "llama-index-readers-bitbucket",
"maintainer": "lejdiprifti",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "bitbucket,project,repository",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/2d/ca/b3509571b2ce25688f4aba396298a4dcf61f87238f27f4efd07212556ae0/llama_index_readers_bitbucket-0.1.3.tar.gz",
"platform": null,
"description": "# Bitbucket Loader\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 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\nBitbucketReader = download_loader(\"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/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.\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.1.3",
"project_urls": null,
"split_keywords": [
"bitbucket",
"project",
"repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62a84bf550100a779eea07dc088eb011d9806c5aeb1100c06c4feec8ab197337",
"md5": "789e8d76cead77ce469f3be6f1e7358c",
"sha256": "25de3cd9e396d228f60e136f6753b1ec9dcf86a1c3588c3b06310824f74a817f"
},
"downloads": -1,
"filename": "llama_index_readers_bitbucket-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "789e8d76cead77ce469f3be6f1e7358c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 3624,
"upload_time": "2024-02-21T19:33:09",
"upload_time_iso_8601": "2024-02-21T19:33:09.956107Z",
"url": "https://files.pythonhosted.org/packages/62/a8/4bf550100a779eea07dc088eb011d9806c5aeb1100c06c4feec8ab197337/llama_index_readers_bitbucket-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2dcab3509571b2ce25688f4aba396298a4dcf61f87238f27f4efd07212556ae0",
"md5": "9728fd2ac8d14049c8a37a47dd7d352a",
"sha256": "80403f39bebadbc25bbb8e43cfdd49403dcd79d1491c78ab3449a96893a2f8be"
},
"downloads": -1,
"filename": "llama_index_readers_bitbucket-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "9728fd2ac8d14049c8a37a47dd7d352a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 3322,
"upload_time": "2024-02-21T19:33:11",
"upload_time_iso_8601": "2024-02-21T19:33:11.247464Z",
"url": "https://files.pythonhosted.org/packages/2d/ca/b3509571b2ce25688f4aba396298a4dcf61f87238f27f4efd07212556ae0/llama_index_readers_bitbucket-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 19:33:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-bitbucket"
}
JSON