coincap-hedera-agent-kit-plugin 0.4__tar.gz → 0.8__tar.gz

{coincap_hedera_agent_kit_plugin-0.4/src/coincap_hedera_agent_kit_plugin.egg-info → coincap_hedera_agent_kit_plugin-0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coincap-hedera-agent-kit-plugin
-Version: 0.4
+Version: 0.8
 Home-page: https://github.com/henrytongv/coincap-hedera-plugin-py
 Author: Henry Tong
 Author-email: taksantong@gmail.com
@@ -51,24 +51,42 @@ COINCAP_BEARER_TOKEN=******************************
 from coincap_hedera_plugin import conincap_h_plugin
 ```
 
-4.- Add the plugin in the plugins secion of the agent
+4.- Import the core_account_query_plugin plugin code
 
+This core plugin is already provided by the Hedera, it is needed to query the account (read its balance)
 ```py
-const hederaAgentToolkit = new HederaLangchainToolkit({
-client,
-configuration: {
-    tools: [],
-    plugins: [coreQueriesPlugin, coreAccountPlugin, CoinCapHederalugin], // <---- Add these
+from hedera_agent_kit.plugins import core_account_query_plugin
 ```
 
-5.- Use a prompt to ask for you current balance and tell the agent to want it in USD currency, for example like this:
+5.- Add the plugin in the plugins secion of the agent
+
+```py
+async def main():
+        ...
+        configuration=Configuration(
+            tools=[],
+            plugins=[
+                core_account_query_plugin,
+                conincap_h_plugin  # <---- add the plugin here
+```
+
+6.- Use a prompt to ask for you current balance and tell the agent to want it in USD currency, for example like this:
 
 ```py
 response = await agent.ainvoke(
     {"messages": [{"role": "user", "content": "Get my balance in HBAR and also convert it to USD please"}]},
 ```
 
-6.- Now you can run the example agent and you should get your current HBAR balance converted to USD currency
+> [!NOTE]
+> The previous prompt results in a multi-step tool invocation:
+> 
+> - Fetch the HBAR balance.
+> - Fetch the current HBAR price.
+> - Convert the balance to USD.
+> 
+> It is important for developers to be aware of, as configurations that limit the agent to only one tool call per request will cause this prompt to fail or behave incorrectly.
+
+7.- Now you can run the example agent and you should get your current HBAR balance converted to USD currency
 
 ```bash
 python main.py
@@ -76,12 +94,39 @@ python main.py
 
 ## Tools
 
+### Get HBAR price in USD
+Invoke the CoinCap API to get the current price in USD of one HBAR
+
+#### Python Function
 ```py
-# Use the CoinCap API to get the current price in USD of one HBAR
 def get_hbar_price_from_coincap():
 ```
 
-## (Optional, only needed when creating your own python package) How to publish a PyPi package
+#### Input Parameters
+
+None
+
+#### Output Values
+
+| Value   | Type     | Description |
+|---------|----------|-------------|
+| Result  | `float` | Value in USD currency of 1 HBAR according to CoinCap |
+
+#### Example Prompt
+
+```
+Get my balance in HBAR and also convert it to USD please
+```
+
+## Optional - Code building, only needed when working on the source code
+
+Use a code formatter, for example `black`
+```bash
+pip install black
+black .
+```
+
+## Optional - Distribution, only needed when creating your own python package) How to publish a PyPi package
 1.- Read the [instructions](https://towardsdatascience.com/how-to-upload-your-python-package-to-pypi-de1b363a1b3/)
 
 1.- Create the distribution package

coincap_hedera_agent_kit_plugin-0.8/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="coincap-hedera-agent-kit-plugin",
+    version="0.8",
+    license="MIT",
+    author="Henry Tong",
+    author_email="taksantong@gmail.com",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    packages=find_packages("src"),
+    package_dir={"": "src"},
+    url="https://github.com/henrytongv/coincap-hedera-plugin-py",
+    keywords="hedera agent-kit coincap web3",
+    install_requires=[
+        "hedera-agent-kit",
+        "requests",
+    ],
+)

{coincap_hedera_agent_kit_plugin-0.4 → coincap_hedera_agent_kit_plugin-0.8/src/coincap_hedera_agent_kit_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coincap-hedera-agent-kit-plugin
-Version: 0.4
+Version: 0.8
 Home-page: https://github.com/henrytongv/coincap-hedera-plugin-py
 Author: Henry Tong
 Author-email: taksantong@gmail.com
@@ -51,24 +51,42 @@ COINCAP_BEARER_TOKEN=******************************
 from coincap_hedera_plugin import conincap_h_plugin
 ```
 
-4.- Add the plugin in the plugins secion of the agent
+4.- Import the core_account_query_plugin plugin code
 
+This core plugin is already provided by the Hedera, it is needed to query the account (read its balance)
 ```py
-const hederaAgentToolkit = new HederaLangchainToolkit({
-client,
-configuration: {
-    tools: [],
-    plugins: [coreQueriesPlugin, coreAccountPlugin, CoinCapHederalugin], // <---- Add these
+from hedera_agent_kit.plugins import core_account_query_plugin
 ```
 
-5.- Use a prompt to ask for you current balance and tell the agent to want it in USD currency, for example like this:
+5.- Add the plugin in the plugins secion of the agent
+
+```py
+async def main():
+        ...
+        configuration=Configuration(
+            tools=[],
+            plugins=[
+                core_account_query_plugin,
+                conincap_h_plugin  # <---- add the plugin here
+```
+
+6.- Use a prompt to ask for you current balance and tell the agent to want it in USD currency, for example like this:
 
 ```py
 response = await agent.ainvoke(
     {"messages": [{"role": "user", "content": "Get my balance in HBAR and also convert it to USD please"}]},
 ```
 
-6.- Now you can run the example agent and you should get your current HBAR balance converted to USD currency
+> [!NOTE]
+> The previous prompt results in a multi-step tool invocation:
+> 
+> - Fetch the HBAR balance.
+> - Fetch the current HBAR price.
+> - Convert the balance to USD.
+> 
+> It is important for developers to be aware of, as configurations that limit the agent to only one tool call per request will cause this prompt to fail or behave incorrectly.
+
+7.- Now you can run the example agent and you should get your current HBAR balance converted to USD currency
 
 ```bash
 python main.py
@@ -76,12 +94,39 @@ python main.py
 
 ## Tools
 
+### Get HBAR price in USD
+Invoke the CoinCap API to get the current price in USD of one HBAR
+
+#### Python Function
 ```py
-# Use the CoinCap API to get the current price in USD of one HBAR
 def get_hbar_price_from_coincap():
 ```
 
-## (Optional, only needed when creating your own python package) How to publish a PyPi package
+#### Input Parameters
+
+None
+
+#### Output Values
+
+| Value   | Type     | Description |
+|---------|----------|-------------|
+| Result  | `float` | Value in USD currency of 1 HBAR according to CoinCap |
+
+#### Example Prompt
+
+```
+Get my balance in HBAR and also convert it to USD please
+```
+
+## Optional - Code building, only needed when working on the source code
+
+Use a code formatter, for example `black`
+```bash
+pip install black
+black .
+```
+
+## Optional - Distribution, only needed when creating your own python package) How to publish a PyPi package
 1.- Read the [instructions](https://towardsdatascience.com/how-to-upload-your-python-package-to-pypi-de1b363a1b3/)
 
 1.- Create the distribution package

{coincap_hedera_agent_kit_plugin-0.4 → coincap_hedera_agent_kit_plugin-0.8}/src/coincap_hedera_agent_kit_plugin.egg-info/SOURCES.txt

@@ -1,5 +1,4 @@
 LICENSE
-README.md
 README.rst
 setup.cfg
 setup.py

{coincap_hedera_agent_kit_plugin-0.4 → coincap_hedera_agent_kit_plugin-0.8}/src/coincap_hedera_plugin/__init__.py

@@ -6,4 +6,4 @@ __all__ = [
 from coincap_hedera_plugin.coincap_plugin import (
     conincap_h_plugin,
     conincap_h_plugin_tool_names,
-)
+)

{coincap_hedera_agent_kit_plugin-0.4 → coincap_hedera_agent_kit_plugin-0.8}/src/coincap_hedera_plugin/coincap_plugin/plugin.py

@@ -13,6 +13,7 @@ from hedera_agent_kit.shared.utils.prompt_generator import PromptGenerator
 
 from coincap_hedera_plugin.coincap_plugin.tool import get_hbar_price_from_coincap
 
+
 def get_hbar_price_in_usd_prompt(context: Context = {}) -> str:
     """Generate a human-readable description of the get hbar price in usd query tool.
 
@@ -35,10 +36,11 @@ Parameters:
 {usage_instructions}
 """
 
+
 async def get_hbar_price_in_usd_query(
     client: Client,
     context: Context,
-    params: AccountQueryParameters,
+    params: None,
 ) -> ToolResponse:
     """Execute a get hbar price in usd request to coincap API.
 
@@ -55,7 +57,9 @@ async def get_hbar_price_in_usd_query(
     """
     try:
         current_price_of_hbar_in_usd = get_hbar_price_from_coincap()
-        print(f"coincap said that the price in USD of one HBAR is {current_price_of_hbar_in_usd}")
+        print(
+            f"coincap said that the price in USD of one HBAR is {current_price_of_hbar_in_usd}"
+        )
         return ToolResponse(
             human_message=str(current_price_of_hbar_in_usd),
         )

{coincap_hedera_agent_kit_plugin-0.4 → coincap_hedera_agent_kit_plugin-0.8}/src/coincap_hedera_plugin/coincap_plugin/tool.py

@@ -1,24 +1,25 @@
 import requests
 import os
 
+
 # Use the CoinCap API to get the current price in USD of one HBAR
 def get_hbar_price_from_coincap():
-    headers = {
-        "Authorization": f"Bearer {os.getenv("BEARER_TOKEN")}"
-    }
+    headers = {"Authorization": f"Bearer {os.getenv("COINCAP_BEARER_TOKEN")}"}
 
     # Send GET request
-    response = requests.get("https://rest.coincap.io/v3/price/bysymbol/hbar", headers=headers)
-    
+    response = requests.get(
+        "https://rest.coincap.io/v3/price/bysymbol/hbar", headers=headers
+    )
+
     # Raise an error if the request failed (4xx / 5xx)
     response.raise_for_status()
-    
+
     # Parse JSON response
     json_data = response.json()
-    
+
     # Get the first element from the "data" array and convert it to float
     first_value = float(json_data["data"][0])
 
     print(f"* got this value from coincap api {first_value}")
-    
-    return first_value
+
+    return first_value

coincap_hedera_agent_kit_plugin-0.4/README.md

@@ -1,78 +0,0 @@
-# Hedera Agent Kit - CoinCap Plugin Python version
-
-A plugin for [Hedera Agent Kit PY](https://github.com/hashgraph/hedera-agent-kit-py) that provides integration with the CoinCap API
-
-In this plugin we use CoinCap to get the current price in USD of one HBAR and combine it with the power of the Hedera Agent Kit to get your current balance of HBA in USD currency.
-
-## Overview
-
-This plugin enables `AI agents` to interact with the CoinCap API
-
-## Installation in the example index.js agent
-
-1.- Install the plugin
-
-```bash
-pip install coincap-hedera-agent-kit-plugin
-```
-
-2.- Add your CoinCap API Bearer token in the .env file ( You get it in the CoinCap website )
-
-```
-# Coincap API needed by coincap-hedera-plugin
-COINCAP_BEARER_TOKEN=******************************
-```
-
-3.- Import the plugin code in your index.js (Hedera Agent)
-
-```py
-from coincap_hedera_plugin import conincap_h_plugin
-```
-
-4.- Add the plugin in the plugins secion of the agent
-
-```py
-const hederaAgentToolkit = new HederaLangchainToolkit({
-client,
-configuration: {
-    tools: [],
-    plugins: [coreQueriesPlugin, coreAccountPlugin, CoinCapHederalugin], // <---- Add these
-```
-
-5.- Use a prompt to ask for you current balance and tell the agent to want it in USD currency, for example like this:
-
-```py
-response = await agent.ainvoke(
-    {"messages": [{"role": "user", "content": "Get my balance in HBAR and also convert it to USD please"}]},
-```
-
-6.- Now you can run the example agent and you should get your current HBAR balance converted to USD currency
-
-```bash
-python main.py
-```
-
-## Tools
-
-```py
-# Use the CoinCap API to get the current price in USD of one HBAR
-def get_hbar_price_from_coincap():
-```
-
-## (Optional, only needed when creating your own python package) How to publish a PyPi package
-1.- Read the [instructions](https://towardsdatascience.com/how-to-upload-your-python-package-to-pypi-de1b363a1b3/)
-
-1.- Create the distribution package
-```bash
-python setup.py sdist
-```
-
-2.- Install twine
-```bash
-pip install twine
-```
-
-3.- Upload package
-```bash
-twine upload dist/*
-```

coincap_hedera_agent_kit_plugin-0.4/setup.py

@@ -1,20 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name='coincap-hedera-agent-kit-plugin',
-    version='0.4',
-    license='MIT',
-    author="Henry Tong",
-    author_email='taksantong@gmail.com',
-    long_description=open('README.md').read(),
-    long_description_content_type='text/markdown',    
-    packages=find_packages('src'),
-    package_dir={'': 'src'},
-    url='https://github.com/henrytongv/coincap-hedera-plugin-py',
-    keywords='hedera agent-kit coincap web3',
-    install_requires=[
-          'hedera-agent-kit',
-          'requests',
-      ],
-
-)