agentstr 0.0.9__py3-none-any.whl → 0.0.10__py3-none-any.whl

agentstr/marketplace.py

@@ -0,0 +1,163 @@
+import logging
+from typing import Optional
+from . import nostr 
+
+try:
+    from phi.tools import Toolkit
+except ImportError:
+    raise ImportError("`phidata` not installed. Please install using `pip install phidata`")
+
+try: 
+    import asyncio
+except ImportError:
+    raise ImportError("`asyncio` not installed. Please install using `pip install asyncio`")
+
+class MerchantProfile():
+
+    logger = logging.getLogger("MerchantProfile")
+    
+    def __init__(
+        self,
+        name: str,
+        about: str,
+        picture: str,
+        nsec: Optional[str] = None
+    ):
+        """Initialize the Merchant profile.
+
+        Args:
+            name: Name for the merchant
+            about: brief description about the merchant
+            picture: url to a png file with a picture for the merchant
+            nsec: private key to be used by this Merchant 
+        """
+
+        # Set log handling for MerchantProfile
+        if not MerchantProfile.logger.hasHandlers():
+            console_handler = logging.StreamHandler()
+            console_handler.setLevel(logging.INFO)
+            formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+            console_handler.setFormatter(formatter)
+            MerchantProfile.logger.addHandler(console_handler)
+        
+        self.name = name
+        self.about = about
+        self.picture = picture
+
+        if nsec:
+            self.private_key = nsec
+            keys = nostr.Keys.parse(self.private_key)
+            self.public_key = keys.public_key().to_bech32()
+            MerchantProfile.logger.info(f"Pre-defined private key reused for {self.name}: {self.private_key}")
+            MerchantProfile.logger.info(f"Pre-defined public key reused for {self.name}: {self.public_key}")
+        else:
+            keys = nostr.Keys.generate()
+            self.private_key = keys.secret_key().to_bech32()
+            self.public_key = keys.public_key().to_bech32()
+            MerchantProfile.logger.info(f"New private key created for {self.name}: {self.private_key}")
+            MerchantProfile.logger.info(f"New public key created for {self.name}: {self.public_key}")
+            
+    def merchant_profile_to_str(self) -> str:
+        return (
+            f"Merchant name: {self.name}. "
+            f"Merchant description: {self.about}. "
+            f"Merchant picture URL: {self.picture}. "
+            f"Private key: {self.private_key}. "
+            f"Public key: {self.public_key}."
+    )
+
+    def get_public_key(self) -> str:
+        return self.public_key
+    
+    def get_private_key(self) -> str:
+        return self.private_key
+    
+    def get_name(self) -> str:
+        return self.name
+    
+    def get_about(self) -> str:
+        return self.about
+    
+    def get_picture(self) -> str:
+        return self.picture
+        
+
+
+class Merchant(Toolkit):
+
+    WEB_URL: str = "http://njump.me/"
+    
+    def __init__(
+        self,
+        merchant_profile: MerchantProfile,
+        relay: str,
+    ):
+        """Initialize the Merchant toolkit.
+
+        Args:
+            merchant_profile: profile of the merchant using this agent
+            relay: Nostr relay to use for communications
+        """
+        super().__init__(name="merchant")
+        self.relay = relay
+        self.merchant_profile = merchant_profile
+
+        # Register all methods
+        self.register(self.publish_merchant_profile)
+        self.register(self.get_merchant_url)
+    
+    def publish_merchant_profile(
+        self
+    ) -> str:
+        """
+        Publishes the merchant profile on Nostr
+
+        Returns:
+            str: with event id and other details if successful or "error" string if unsuccesful
+        """
+        # Run the async pubilshing function synchronously
+        return asyncio.run(self._async_publish_merchant_profile())
+    
+    async def _async_publish_merchant_profile(
+        self
+    ) -> str:
+        """
+        Asynchronous method to publish the merchant profile on Nostr
+
+        Returns:
+            str: with event id and other details if successful or "error" string if unsuccesful
+        """
+        
+        nostr_client = nostr.NostrClient(self.relay, self.merchant_profile.get_private_key())
+        
+        # Connect to the relay
+        outcome = await nostr_client.connect()
+
+        # Check if the operation resulted in an error
+        if outcome == nostr.NostrClient.ERROR:
+            return nostr.NostrClient.ERROR
+        else:
+            eventid = await nostr_client.publish_profile(
+                self.merchant_profile.get_name(),
+                self.merchant_profile.get_about(),
+                self.merchant_profile.get_picture()
+            )
+
+            # Check if the operation resulted in an error
+            if eventid == nostr.NostrClient.ERROR:
+                return nostr.NostrClient.ERROR
+        
+            # Return the event ID and merchant profile details
+            return eventid + self.merchant_profile.merchant_profile_to_str()
+    
+    def get_merchant_url(
+        self
+    ) -> str:
+        """
+        Returns URL with merchant profile
+
+        Returns:
+            str: valid URL with merchant profile
+        """
+
+        return self.WEB_URL + self.merchant_profile.get_public_key()

agentstr/nostr.py

@@ -0,0 +1,141 @@
+from typing import Optional
+from os import getenv
+import logging 
+
+try: 
+    import asyncio
+except ImportError:
+    raise ImportError("`asyncio` not installed. Please install using `pip install asyncio`")
+
+try:
+    from nostr_sdk import Keys, Client, EventBuilder, NostrSigner, SendEventOutput, Event, Metadata
+except ImportError:
+    raise ImportError("`nostr_sdk` not installed. Please install using `pip install nostr_sdk`")
+
+class NostrClient():
+   
+    logger = logging.getLogger("NostrClient")
+    ERROR: str = "ERROR"
+    SUCCESS: str = "SUCCESS"
+    
+    def __init__(
+        self,
+        relay: str = None,
+        nsec: str = None,
+    ):
+        """Initialize the Nostr client.
+
+        Args:
+            relay: Nostr relay that the client will connect to 
+            nsec: Nostr private key in bech32 format
+        """
+        # Set log handling
+        if not NostrClient.logger.hasHandlers():
+            console_handler = logging.StreamHandler()
+            console_handler.setLevel(logging.INFO)
+            formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+            console_handler.setFormatter(formatter)
+            NostrClient.logger.addHandler(console_handler)
+       
+        self.relay = relay
+        self.keys = Keys.parse(nsec)
+        self.nostr_signer = NostrSigner.keys(self.keys)
+        self.client = Client(self.nostr_signer)
+            
+
+    async def connect(
+        self
+    ) -> str:
+        
+        """Add relay to the NostrClient instance and connect to it.
+
+        Returns:
+            str: NostrClient.SUCCESS or NostrClient.ERROR
+        """
+        try:
+            await self.client.add_relay(self.relay)
+            NostrClient.logger.info(f"Relay {self.relay} succesfully added.")
+            await self.client.connect()
+            NostrClient.logger.info("Connected to relay.")
+            return NostrClient.SUCCESS
+        except Exception as e:
+            NostrClient.logger.error(f"Unable to connect to relay {self.relay}. Exception: {e}.")
+            return NostrClient.ERROR
+        
+    async def publish_text_note(
+        self,
+        text: str
+    ) -> str:
+        
+        """Publish kind 1 event (text note) to the relay 
+
+        Args:
+            text: text to be published as kind 1 event
+
+        Returns:
+            str: event id if successful and "error" string if unsuccesful
+        """
+        builder = EventBuilder.text_note(text)
+
+        try:
+            output = await self.client.send_event_builder(builder)
+            NostrClient.logger.info(f"Text note published with event id: {output.id.to_bech32()}")
+            return output.id.to_bech32()
+        except Exception as e:
+            NostrClient.logger.error(f"Unable to publish text note to relay {self.relay}. Exception: {e}.")
+            return NostrClient.ERROR
+
+    async def publish_event(
+        self,
+        builder: EventBuilder
+    ) -> str:
+        
+        """Publish generic Nostr event to the relay
+
+        Returns:
+            str: event id if successful or "error" string if unsuccesful
+        """
+        try:
+            output = await self.client.send_event_builder(builder)
+            NostrClient.logger.info(f"Event published with event id: {output.id.to_bech32()}")
+            return output.id.to_bech32()
+        except Exception as e:
+            NostrClient.logger.error(f"Unable to publish event to relay {self.relay}. Exception: {e}.")
+            return NostrClient.ERROR
+    
+    async def publish_profile(self, name: str, about: str, picture: str) -> str:
+        """Publish a Nostr profile.
+
+        Args:
+            name: name of the Nostr profile
+            about: brief description about the profile
+            picture: url to a png file with a picture for the profile
+        
+        Returns:
+            str: event id if successful or "error" string if unsuccesful
+        """
+        metadata_content = Metadata().set_name(name)
+        metadata_content = metadata_content.set_about(about)
+        metadata_content = metadata_content.set_picture(picture)
+
+        builder = EventBuilder.metadata(metadata_content)
+        try:
+            output = await self.client.send_event_builder(builder)
+            NostrClient.logger.info(f"Profile note published with event id: {output.id.to_bech32()}")
+            return output.id.to_bech32()
+        except Exception as e:
+            NostrClient.logger.error(f"Unable to publish profile to relay {self.relay}. Exception: {e}.")
+            return NostrClient.ERROR
+
+    @classmethod
+    def set_logging_level(cls, logging_level: int):
+        """
+        Set the logging level for the NostrClient logger.
+
+        Args:
+           logging_level (int): The logging level (e.g., logging.DEBUG, logging.INFO).
+        """
+        cls.logger.setLevel(logging_level)
+        for handler in cls.logger.handlers:
+           handler.setLevel(logging_level)
+        cls.logger.info(f"Logging level set to {logging.getLevelName(logging_level)}")

{agentstr-0.0.9.dist-info → agentstr-0.0.10.dist-info}/METADATA

@@ -1,9 +1,7 @@
 Metadata-Version: 2.2
 Name: agentstr
-Version: 0.0.9
+Version: 0.0.10
 Summary: A library for collaborative AI agents
-Home-page: https://github.com/synvya/agentstr
-Author: Alejandro Gil
 Author-email: Alejandro Gil <info@synvya.com>
 License: MIT
 Project-URL: Homepage, https://github.com/synvya/agentstr
@@ -13,14 +11,13 @@ Keywords: AI,agents,collaboration,library
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: <3.13,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: phidata>=2.7.0
 Requires-Dist: openai>=1.50.0
-Dynamic: author
-Dynamic: home-page
-Dynamic: requires-python
+Requires-Dist: packaging>=24.0
+Requires-Dist: nostr-sdk>=0.38.0
 
 AgentStr
 ========
@@ -28,6 +25,10 @@ AgentStr is an extension of [Phidata](https://www.phidata.com) AI agents that al
 
 The goal is for Agent A operated by Company A to be able to work with Agent B operated by Company B to achieve a common goal. For example: Company A wants to buy a product sold by Company B so Agent A and Agent B can coordinate and execute the transaction. 
 
+The basic communication tools are implemented in `agentstr/nostr.py`. 
+
+As a first example, AgentStr provides the tools to create and operate a marketplace using the [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) Nostr Marketplace as its foundation. The file `agentstr/marketplace.py` includes NIP-15 `merchant` and `customer` profiles implemented each as a Phidata Toolkit. 
+
 # License
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
@@ -36,16 +37,13 @@ The library is in its infancy.
 
 Done:
 - Workflow to package and distribute the library
-- Create AgentStr as an extension of Phidata Agent
-- Test the addition of new properties and capabilities for the AgentStr class
+- Users can create a Merchant profile and create an agent with the `merchant` toolkit that acts on behalf of the Merchant profile
+
 
 To be done:
-- Incorporate Nostr capabilities
-- Create unique public / private key identifiers for agent instances
-- Send and retreive messages via Nostr
-- Expose capabilities via Nostr
-- Agent B retrieves capabilities exposed by Agent A
-- Agent B coordinates transaction with Agent A
+- Create a `marketplace` with `stalls`
+- Merchants to define `products`
+- Create a `customer` Toolkit
 
 # Installation
 AgentStr is offered as a python library available at https://pypi.org/project/agentstr/. 
@@ -56,10 +54,11 @@ Here is an example on how to use the library:
     ```
     cd ~/
     python3 -m venv ~/.venvs/aienv
-    source ~/.venvs/aienv/bin/acticate
+    source ~/.venvs/aienv/bin/activate
     ```
 2. Install the agentstr library
     ```
+    pip install --upgrade pip
     pip install agentstr
     mkdir ~/mysampleapp
     cd ~/mysampleapp
@@ -70,24 +69,43 @@ Here is an example on how to use the library:
     ```
 4. Copy paste this code to the main.py file
     ```
-    from agentstr.core import AgentStr
-    # Create the agent
-    agent = AgentStr("Synvya Inc", "Seller")
+    from dotenv import load_dotenv
+    from os import getenv
+    from phi.agent import Agent 
+    from phi.model.openai import OpenAIChat
+    from agentstr.marketplace import MerchantProfile, Merchant
 
-    # Test AgentStr new capabilities
-    print(f"Public key: {agent.get_public_key()}\nPrivate key: {agent.get_private_key()}")
-    print(f"Company: {agent.get_company()}\nRole: {agent.get_role()}")
 
-    # Test phidata inherited capabilities
-    agent.print_response("Write two sentence poem for  the love between the sun and the moon.") 
+    profile = MerchantProfile(
+        "Synvya",
+        "Testing stuff",
+        "https://i.nostr.build/ocjZ5GlAKwrvgRhx.png",
+        getenv("NSEC_KEY")
+    )
+
+    agent = Agent(
+        name="Merchant Assistant",
+        model=OpenAIChat(id="gpt-4o"),
+        tools=[Merchant(merchant_profile=profile, relay="wss://relay.damus.io")],
+        show_tool_calls=True,
+        markdown=True,
+        debug_mode=True
+    )
+    
+    agent.print_response("Publish the merchant information and tell me the event id used")
     ```
-5. Run the code
+5. Export your OpenAI key and optionally a Nostr private key before running the code
     ```
+    export OPENAI_API_KEY="sk-***"
+    export NSEC_KEY="nsec***"
     python main.py
     ```
 
+This example will attempt to load a Nostr private key defined as NSEC_KEY in bech32 format. If a private key is not provided, the `MerchantProfile` class initializer will assign it a new one. 
+
 # Contributing
 Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for specific instructions on installation instructions for developers and how to contribute.
 
 # Acknowledgments
-- [Phidata](https://www.phidata.com/.com/) - For building robust AI agents.
+- [Phidata](https://www.phidata.com) - For building robust AI agents.
+- [Rust-Nostr](https://rust-nostr.org/index.html) - For providing a python based Nostr SDK.

agentstr-0.0.10.dist-info/RECORD

@@ -0,0 +1,8 @@
+agentstr/__init__.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
+agentstr/marketplace.py,sha256=XYF2ZrF6MpmxgCEOz3uN436cj7F4VHyUATFk8gmr7Zg,5245
+agentstr/nostr.py,sha256=C5zMWKBbXLkarZxBoTydJCZVzqGoCogBd_9v8Gll0VU,5012
+agentstr-0.0.10.dist-info/LICENSE,sha256=xF8akIKB07gOtkhjENT0xVbWGdFp4-srDKpZKjD03Js,1063
+agentstr-0.0.10.dist-info/METADATA,sha256=GuVKTLwjr6Skj4HH387GQP7YYMnTKulqgh8OQuuJGvs,4082
+agentstr-0.0.10.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+agentstr-0.0.10.dist-info/top_level.txt,sha256=KZObFRHppZvKUGYB_m9w5HhLwps7jj7w6Xrw73dH2ss,9
+agentstr-0.0.10.dist-info/RECORD,,

agentstr/core.py

@@ -1,42 +0,0 @@
-from phi.agent import Agent
-from phi.model.openai import OpenAIChat
-from pydantic import Field
-from typing import Optional
-
-
-class AgentStr(Agent):
-
-    # -*- Agent settings  
-    # Company operating the agent.
-    # Used as seed for public / private key identifier together with the agent role
-    company: str = None
-    
-    # -*- Agent public / private key identifiers
-    # The public / private key should be deterministic for a given 'company' and 'role' combination
-    # Public key for the agent
-    npub: str = None
-    # Private key for the agent
-    nsec: str = None
-
-    # Call the parent class (Agent) constructor
-    def __init__(self, company: str, role: str):
-        super().__init__(role = role, model=OpenAIChat(id="gpt-4o"))
-        self.company = company
-        self.npub = f"npub - {self.company} - {self.role}" 
-        self.nsec = f"nsec - {self.company} - {self.role}"
-
-    def get_public_key(self) -> str:
-        return self.npub
-    
-    def get_private_key(self) -> str:
-        return self.nsec
-    
-    def get_company(self) -> str:
-        return self.company
-    
-    def get_role(self) -> str:
-        return self.role
-
-def add(a, b):
-    """Add two numbers."""
-    return a + b

agentstr-0.0.9.dist-info/RECORD

@@ -1,7 +0,0 @@
-agentstr/__init__.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
-agentstr/core.py,sha256=xS5q8ltl81DqLjKgiVtjUQ5r-jbEPXXjTlJ0pWcV5p8,1214
-agentstr-0.0.9.dist-info/LICENSE,sha256=xF8akIKB07gOtkhjENT0xVbWGdFp4-srDKpZKjD03Js,1063
-agentstr-0.0.9.dist-info/METADATA,sha256=0H9Gophcg8p8Hw3vCZhQanTZTb9EGkCNvMWXsA_aOo0,3194
-agentstr-0.0.9.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-agentstr-0.0.9.dist-info/top_level.txt,sha256=KZObFRHppZvKUGYB_m9w5HhLwps7jj7w6Xrw73dH2ss,9
-agentstr-0.0.9.dist-info/RECORD,,