llama-index-packs-stock-market-data-query-engine


Namellama-index-packs-stock-market-data-query-engine JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
Summaryllama-index packs stock_market_data_query_engine integration
upload_time2024-11-18 01:31:39
maintaineranoopshrma
docs_urlNone
authorYour Name
requires_python<4.0,>=3.9
licenseMIT
keywords data engine finance market query stock yahoo finance yahoo
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Stock Market Data Query Engine Pack

Query and retrieve historical market data for a list of stock tickers. It utilizes Yahoo Finance [(yfinance)](https://pypi.org/project/yfinance/) to fetch historical stock prices.

## CLI Usage

You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:

```bash
llamaindex-cli download-llamapack StockMarketDataQueryEnginePack --download-dir ./stock_market_data_pack
```

You can then inspect the files at `./stock_market_data_pack` and use them as a template for your own project.

## Code Usage

You can download the pack to a the `./stock_market_data_pack` directory:

```python
from llama_index.core.llama_pack import download_llama_pack

# download and install dependencies
StockMarketDataQueryEnginePack = download_llama_pack(
    "StockMarketDataQueryEnginePack", "./stock_market_data_pack"
)
```

From here, you can use the pack, or inspect and modify the pack in `./stock_market_data_pack`.

Then, you can set up the pack like so:

```python
# create the pack
stock_market_data_pack = StockMarketDataQueryEnginePack(
    ["MSFT"],
    period="1mo",
)
```

The `run()` function is a light wrapper around `query_engine.query()`.

```python
response = stock_market_data_pack.run(
    "What is the average closing price for MSFT?"
)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-packs-stock-market-data-query-engine",
    "maintainer": "anoopshrma",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "data, engine, finance, market, query, stock, yahoo finance, yahoo",
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/40/dd/8f34caaf7b1dd79678f14bf1ab77565296a37ced7ec145a79a534c7e360c/llama_index_packs_stock_market_data_query_engine-0.4.0.tar.gz",
    "platform": null,
    "description": "# Stock Market Data Query Engine Pack\n\nQuery and retrieve historical market data for a list of stock tickers. It utilizes Yahoo Finance [(yfinance)](https://pypi.org/project/yfinance/) to fetch historical stock prices.\n\n## CLI Usage\n\nYou can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:\n\n```bash\nllamaindex-cli download-llamapack StockMarketDataQueryEnginePack --download-dir ./stock_market_data_pack\n```\n\nYou can then inspect the files at `./stock_market_data_pack` and use them as a template for your own project.\n\n## Code Usage\n\nYou can download the pack to a the `./stock_market_data_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nStockMarketDataQueryEnginePack = download_llama_pack(\n    \"StockMarketDataQueryEnginePack\", \"./stock_market_data_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./stock_market_data_pack`.\n\nThen, you can set up the pack like so:\n\n```python\n# create the pack\nstock_market_data_pack = StockMarketDataQueryEnginePack(\n    [\"MSFT\"],\n    period=\"1mo\",\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = stock_market_data_pack.run(\n    \"What is the average closing price for MSFT?\"\n)\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index packs stock_market_data_query_engine integration",
    "version": "0.4.0",
    "project_urls": null,
    "split_keywords": [
        "data",
        " engine",
        " finance",
        " market",
        " query",
        " stock",
        " yahoo finance",
        " yahoo"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c267c0b66d73c44d7ba34c89300553d47dca1806b789a5ae410611b6a3a7742d",
                "md5": "08dfd145f95afc141e4c2dbb3c848c74",
                "sha256": "dfdecae064abb0d7115d3785b61ba6f537534986f67d33a9b3315a0a8cdf6c77"
            },
            "downloads": -1,
            "filename": "llama_index_packs_stock_market_data_query_engine-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "08dfd145f95afc141e4c2dbb3c848c74",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 3539,
            "upload_time": "2024-11-18T01:31:38",
            "upload_time_iso_8601": "2024-11-18T01:31:38.447429Z",
            "url": "https://files.pythonhosted.org/packages/c2/67/c0b66d73c44d7ba34c89300553d47dca1806b789a5ae410611b6a3a7742d/llama_index_packs_stock_market_data_query_engine-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "40dd8f34caaf7b1dd79678f14bf1ab77565296a37ced7ec145a79a534c7e360c",
                "md5": "ce202b3023cf3a0ea8c71e47b270c502",
                "sha256": "e8652cf9122acaa01496de5ee1dcb29e4eb10881fd7806eb7853fffa8c7dbfa5"
            },
            "downloads": -1,
            "filename": "llama_index_packs_stock_market_data_query_engine-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ce202b3023cf3a0ea8c71e47b270c502",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 3126,
            "upload_time": "2024-11-18T01:31:39",
            "upload_time_iso_8601": "2024-11-18T01:31:39.260269Z",
            "url": "https://files.pythonhosted.org/packages/40/dd/8f34caaf7b1dd79678f14bf1ab77565296a37ced7ec145a79a534c7e360c/llama_index_packs_stock_market_data_query_engine-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-18 01:31:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-packs-stock-market-data-query-engine"
}
        
Elapsed time: 0.40604s