agentstr 0.1.10__py3-none-any.whl → 0.1.11__py3-none-any.whl

{agentstr-0.1.10.dist-info → agentstr-0.1.11.dist-info}/METADATA

@@ -1,31 +1,11 @@
 Metadata-Version: 2.2
 Name: agentstr
-Version: 0.1.10
+Version: 0.1.11
 Summary: Nostr extension for Phidata AI agents
 Author-email: Synvya <info@synvya.com>
-License: MIT License
-        
-        Copyright (c) 2025 Synvya
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/synvya/agentstr
+License: MIT
+Project-URL: Homepage, https://www.synvya.com
+Project-URL: Repository, https://github.com/synvya/agentstr
 Project-URL: Documentation, https://github.com/synvya/agentstr#readme
 Project-URL: BugTracker, https://github.com/synvya/agentstr/issues
 Requires-Python: <3.13,>=3.9
@@ -100,15 +80,48 @@ pip install agentstr
 
 ## Examples
 
-See our [examples directory](https://github.com/Synvya/agentstr/tree/main/examples/) for complete working implementations:
+You can find example code in the [examples](https://github.com/Synvya/agentstr/tree/main/examples/) directory.
 
-- [Basic CLI Agent](https://github.com/Synvya/agentstr/tree/main/examples/basic_cli/main.py) - A complete example showing:
+### Instaling the examples
+1. **Clone the repository**
+```bash
+git clone https://github.com/Synvya/agentstr.git
+```
+
+### Basic CLI Example
+A simple command-line interface demonstrating agentstr's merchant capabilities:
+
+
+- [Basic CLI Agent](https://github.com/Synvya/agentstr/tree/main/src/agentstr/examples/basic_cli/main.py) - A complete example showing:
   - Setting up merchant profiles
   - Creating stalls with shipping methods
   - Defining products with shipping costs
   - Configuring the agent with the merchant toolkit
   - Running an interactive CLI application
 
+1. ** Create a virtual environment**
+```bash
+cd agentstr/examples/basic_cli
+python3 -m venv venv
+source venv/bin/activate
+```
+
+2. ** Install dependencies**
+```bash
+pip install -r requirements.txt
+```
+
+3. ** Configure your environment**
+```bash
+cp .env.example .env
+```
+**Edit the .env file with your own API keys and Nostr credentials**
+
+4. ** Run the example**
+```bash
+python main.py
+```
+
 
 ## Documentation
 
@@ -116,14 +129,14 @@ For more detailed documentation and examples, see [Docs](https://github.com/Synv
 
 ## Development
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for:
+See [CONTRIBUTING.md](https://github.com/Synvya/agentstr/blob/main/CONTRIBUTING.md) for:
 - Development setup
 - Testing instructions
 - Contribution guidelines
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/Synvya/agentstr/blob/main/LICENSE) file for details.
 
 ## Acknowledgments
 

agentstr-0.1.11.dist-info/RECORD

@@ -0,0 +1,8 @@
+agentstr/__init__.py,sha256=bPXCN4fDtqII9UtDCwhWhkR6bi1LR4w0rR0vGeKPNoI,567
+agentstr/marketplace.py,sha256=CavX0WQaCiz1sQhVs-PaHZ4YYUdcabW5V5eXrhtbT5A,40406
+agentstr/nostr.py,sha256=PId6477VuShPq7nKgansgyJhJNNy9S8ycCf_3niizg4,11242
+agentstr-0.1.11.dist-info/LICENSE,sha256=20H0yoEDN5XO1xPXyZCyJjvSTP0YiarRMKWPfiaBhQY,1063
+agentstr-0.1.11.dist-info/METADATA,sha256=Vd8WUSeuBXcLgutM8deaNa4mxb4tESgAKgjD6gFLJ40,4314
+agentstr-0.1.11.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+agentstr-0.1.11.dist-info/top_level.txt,sha256=KZObFRHppZvKUGYB_m9w5HhLwps7jj7w6Xrw73dH2ss,9
+agentstr-0.1.11.dist-info/RECORD,,

agentstr/examples/basic_cli/.env.example

@@ -1,2 +0,0 @@
-OPENAI_API_KEY="your-openai-api-key"
-NSEC_BASIC_CLI_KEY="your-nsec-test-key"

agentstr/examples/basic_cli/README.md

@@ -1,11 +0,0 @@
-# Basic CLI Agent Example
-
-This example demonstrates a complete setup of a merchant agent with:
-- Multiple stalls (Hardware Store and Trade School)
-- Multiple products per stall
-- Different shipping zones and costs
-- Interactive CLI interface
-
-## Setup
-
-1. Copy `.env.example` to `.env` and fill in your keys: 

agentstr/examples/basic_cli/main.py

@@ -1,193 +0,0 @@
-from os import getenv
-from pathlib import Path
-from typing import List, Tuple
-
-import httpx
-from dotenv import load_dotenv
-from phi.agent import Agent  # type: ignore
-from phi.model.openai import OpenAIChat  # type: ignore
-
-from agentstr.marketplace import (
-    Merchant,
-    MerchantProduct,
-    MerchantStall,
-    Profile,
-    ShippingCost,
-    ShippingMethod,
-)
-
-load_dotenv()
-
-RELAY = "wss://relay.damus.io"
-
-# --*-- Merchant info
-MERCHANT_NAME = "Merchant 1"
-MERCHANT_DESCRIPTION = "Selling products peer to peer"
-MERCHANT_PICTURE = "https://i.nostr.build/ocjZ5GlAKwrvgRhx.png"
-
-# --*-- Stall info
-STALL_1_NAME = "The Hardware Store"
-STALL_1_ID = "212au4Pi"  # "212a26qV"
-STALL_1_DESCRIPTION = "Your neighborhood hardware store, now available online."
-STALL_1_CURRENCY = "Sats"
-
-STALL_2_NAME = "The Trade School"
-STALL_2_ID = "c8762EFD"
-STALL_2_DESCRIPTION = (
-    "Educational videos to put all your hardware supplies to good use."
-)
-STALL_2_CURRENCY = "Sats"
-
-# --*-- Shipping info
-SHIPPING_ZONE_1_NAME = "North America"
-SHIPPING_ZONE_1_ID = "64be11rM"
-SHIPPING_ZONE_1_REGIONS = ["Canada", "Mexico", "USA"]
-
-SHIPPING_ZONE_2_NAME = "Rest of the World"
-SHIPPING_ZONE_2_ID = "d041HK7s"
-SHIPPING_ZONE_2_REGIONS = ["All other countries"]
-
-SHIPPING_ZONE_3_NAME = "Worldwide"
-SHIPPING_ZONE_3_ID = "R8Gzz96K"
-SHIPPING_ZONE_3_REGIONS = ["Worldwide"]
-
-# --*-- Product info
-PRODUCT_1_NAME = "Wrench"
-PRODUCT_1_ID = "bcf00Rx7"
-PRODUCT_1_DESCRIPTION = "The perfect tool for a $5 wrench attack."
-PRODUCT_1_IMAGES = ["https://i.nostr.build/BddyYILz0rjv1wEY.png"]
-PRODUCT_1_CURRENCY = STALL_1_CURRENCY
-PRODUCT_1_PRICE = 5000
-PRODUCT_1_QUANTITY = 100
-
-PRODUCT_2_NAME = "Shovel"
-PRODUCT_2_ID = "bcf00Rx8"
-PRODUCT_2_DESCRIPTION = "Dig holes like never before"
-PRODUCT_2_IMAGES = ["https://i.nostr.build/psL0ZtN4FZcmeiIh.png"]
-PRODUCT_2_CURRENCY = STALL_1_CURRENCY
-PRODUCT_2_PRICE = 10000
-PRODUCT_2_QUANTITY = 10
-
-PRODUCT_3_NAME = "Shovel 101"
-PRODUCT_3_ID = "ccf00Rx1"
-PRODUCT_3_DESCRIPTION = "How to dig your own grave"
-PRODUCT_3_IMAGES = ["https://i.nostr.build/psL0ZtN4FZcmeiIh.png"]
-PRODUCT_3_CURRENCY = STALL_2_CURRENCY
-PRODUCT_3_PRICE = 1000
-PRODUCT_3_QUANTITY = 1000
-
-# --*-- Define Shipping methods for stalls (nostr SDK type)
-shipping_method_1 = (
-    ShippingMethod(id=SHIPPING_ZONE_1_ID, cost=5000)
-    .name(SHIPPING_ZONE_1_NAME)
-    .regions(SHIPPING_ZONE_1_REGIONS)
-)
-
-shipping_method_2 = (
-    ShippingMethod(id=SHIPPING_ZONE_2_ID, cost=5000)
-    .name(SHIPPING_ZONE_2_NAME)
-    .regions(SHIPPING_ZONE_2_REGIONS)
-)
-
-shipping_method_3 = (
-    ShippingMethod(id=SHIPPING_ZONE_3_ID, cost=0)
-    .name(SHIPPING_ZONE_3_NAME)
-    .regions(SHIPPING_ZONE_3_REGIONS)
-)
-
-# --*-- Define Shipping costs for products (nostr SDK type)
-shipping_cost_1 = ShippingCost(id=SHIPPING_ZONE_1_ID, cost=1000)
-shipping_cost_2 = ShippingCost(id=SHIPPING_ZONE_2_ID, cost=2000)
-shipping_cost_3 = ShippingCost(id=SHIPPING_ZONE_3_ID, cost=3000)
-
-# --*-- define stalls (using ShippingMethod)
-test_stall_1 = MerchantStall(
-    id=STALL_1_ID,
-    name=STALL_1_NAME,
-    description=STALL_1_DESCRIPTION,
-    currency=STALL_1_CURRENCY,
-    shipping=[shipping_method_1, shipping_method_2],
-)
-
-test_stall_2 = MerchantStall(
-    id=STALL_2_ID,
-    name=STALL_2_NAME,
-    description=STALL_2_DESCRIPTION,
-    currency=STALL_2_CURRENCY,
-    shipping=[shipping_method_3],  # Uses ShippingMethod
-)
-
-# --*-- define products (using ShippingZone)
-test_product_1 = MerchantProduct(
-    id=PRODUCT_1_ID,
-    stall_id=STALL_1_ID,
-    name=PRODUCT_1_NAME,
-    description=PRODUCT_1_DESCRIPTION,
-    images=PRODUCT_1_IMAGES,
-    currency=PRODUCT_1_CURRENCY,
-    price=PRODUCT_1_PRICE,
-    quantity=PRODUCT_1_QUANTITY,
-    shipping=[shipping_cost_1, shipping_cost_2],
-    categories=None,
-    specs=[],  # List of lists of strings, e.g. [["Color", "Red"], ["Size", "Large"]]
-)
-
-test_product_2 = MerchantProduct(
-    id=PRODUCT_2_ID,
-    stall_id=STALL_1_ID,
-    name=PRODUCT_2_NAME,
-    description=PRODUCT_2_DESCRIPTION,
-    images=PRODUCT_2_IMAGES,
-    currency=PRODUCT_2_CURRENCY,
-    price=PRODUCT_2_PRICE,
-    quantity=PRODUCT_2_QUANTITY,
-    shipping=[shipping_cost_1, shipping_cost_2],
-    categories=None,
-    specs=[],  # List of lists of strings
-)
-
-test_product_3 = MerchantProduct(
-    id=PRODUCT_3_ID,
-    stall_id=STALL_2_ID,
-    name=PRODUCT_3_NAME,
-    description=PRODUCT_3_DESCRIPTION,
-    images=PRODUCT_3_IMAGES,
-    currency=PRODUCT_3_CURRENCY,
-    price=PRODUCT_3_PRICE,
-    quantity=PRODUCT_3_QUANTITY,
-    shipping=[shipping_cost_3],
-    categories=None,
-    specs=[],  # List of lists of strings
-)
-
-nsec = getenv("NSEC_BASIC_CLI_KEY")
-if nsec:
-    print(f"nsec: {nsec}")
-else:
-    print(f"No NSEC found")
-
-
-test_merchant = Profile(MERCHANT_NAME, MERCHANT_DESCRIPTION, MERCHANT_PICTURE, nsec)
-
-
-agent = Agent(  # type: ignore[call-arg]
-    name="Merchant Assistant",
-    model=OpenAIChat(id="gpt-4o"),
-    tools=[
-        Merchant(
-            merchant_profile=test_merchant,
-            relay=RELAY,
-            stalls=[test_stall_1, test_stall_2],
-            products=[test_product_1, test_product_2, test_product_3],
-        )
-    ],
-    show_tool_calls=True,
-    debug_mode=True,
-    async_mode=True,
-    instructions=[
-        "The Merchant Toolkit functions return JSON arrays. Provide these JSON arrays back to the console as output."
-    ],
-)
-
-# agent.print_response("List the products of the merchant")
-agent.cli_app(stream=False)

agentstr-0.1.10.dist-info/RECORD

@@ -1,11 +0,0 @@
-agentstr/__init__.py,sha256=bPXCN4fDtqII9UtDCwhWhkR6bi1LR4w0rR0vGeKPNoI,567
-agentstr/marketplace.py,sha256=CavX0WQaCiz1sQhVs-PaHZ4YYUdcabW5V5eXrhtbT5A,40406
-agentstr/nostr.py,sha256=PId6477VuShPq7nKgansgyJhJNNy9S8ycCf_3niizg4,11242
-agentstr/examples/basic_cli/.env.example,sha256=yt6kWhUgnV2wlDlilpiOIZDdJtYL_QVhtbCGl7EG58c,76
-agentstr/examples/basic_cli/README.md,sha256=ibZ1LMOZj1BGjtDxxhTLvHwbG-H6NqfobP_zPCJoYZM,310
-agentstr/examples/basic_cli/main.py,sha256=Jgzvk0ep1zFHbDns5SQzJQvDMTQqBuRdsFSkfqEc5S8,5418
-agentstr-0.1.10.dist-info/LICENSE,sha256=20H0yoEDN5XO1xPXyZCyJjvSTP0YiarRMKWPfiaBhQY,1063
-agentstr-0.1.10.dist-info/METADATA,sha256=3XSiQurtRGtTWnXvrYqdZQpXu0ry7yF0_Rot6SdfWg0,4792
-agentstr-0.1.10.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-agentstr-0.1.10.dist-info/top_level.txt,sha256=KZObFRHppZvKUGYB_m9w5HhLwps7jj7w6Xrw73dH2ss,9
-agentstr-0.1.10.dist-info/RECORD,,