Skip to main content

LlamaIndex tools for the OptionsAhoy equity-compensation calculators.

Project description

llama-index-tools-optionsahoy

LlamaIndex tools for the OptionsAhoy equity-compensation calculators. OptionsAhoyToolSpec exposes one tool per OptionsAhoy REST endpoint, built on top of the keyless optionsahoy client. No application programming interface (API) key is required.

Covered calculators: incentive stock option (ISO) / alternative minimum tax (AMT) optimizer, non-qualified stock options (NSO), restricted stock units (RSU) sell-versus-hold, single-stock concentration, protective put hedge pricing, qualified small business stock (QSBS), and funding a cash goal from equity.

Install

From this repository, install both packages editable:

pip install -e integrations/python/optionsahoy
pip install -e integrations/python/llama-index-tools-optionsahoy

Usage

from llama_index.tools.optionsahoy import OptionsAhoyToolSpec

spec = OptionsAhoyToolSpec()
tools = spec.to_tool_list()  # one FunctionTool per endpoint

# Hand to any LlamaIndex agent:
#   from llama_index.core.agent import ReActAgent
#   agent = ReActAgent.from_tools(tools, llm=...)
# or call a tool directly:
qsbs = next(t for t in tools if t.metadata.name == "qsbs_check")
result = qsbs.call(
    acquisitionDate="2018-01-01",
    saleDate="2026-02-01",
    entityType="us-c-corp",
    acquisitionMethod="original-issuance",
    assetCategory="under-50m",
    industry="tech-software",
    activeBusiness="yes",
    adjustedBasis=10000,
    expectedGain=2000000,
    stateCode="CA",
    ordinaryIncome=250000,
    filingStatus="single",
)
print(result.raw_output)

Pass your own configured client with OptionsAhoyToolSpec(client=OptionsAhoyClient(...)).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llama_index_tools_optionsahoy-0.1.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llama_index_tools_optionsahoy-0.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file llama_index_tools_optionsahoy-0.1.0.tar.gz.

File metadata

File hashes

Hashes for llama_index_tools_optionsahoy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 75bd5da544cac71a4b71c2dac5cf4065f5129d86e0c153907b12df5ba3b3545a
MD5 fdbcbf04b5b6eb8ffa6a98c15f3563f2
BLAKE2b-256 3f0b51bdf86c4dccf3eeefe8d2dbc2e784ae2856a0f7a3ab53cb7fb9e626121a

See more details on using hashes here.

Provenance

The following attestation bundles were made for llama_index_tools_optionsahoy-0.1.0.tar.gz:

Publisher: publish-python.yml on AlvisoOculus/optionsahoy-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file llama_index_tools_optionsahoy-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for llama_index_tools_optionsahoy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a35afdbc6afff4fef31e45329d1f057ce2a952f4dbc413d58c15a5cc3d5560e
MD5 05456f6af4faaf277f618400a56e63e2
BLAKE2b-256 8cbe446a1c23faa5a01f63cb8902af2cb2965d8897dd06685b53899af009709a

See more details on using hashes here.

Provenance

The following attestation bundles were made for llama_index_tools_optionsahoy-0.1.0-py3-none-any.whl:

Publisher: publish-python.yml on AlvisoOculus/optionsahoy-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page