volttron-platform-lookup 0.1.0rc0__tar.gz

volttron_platform_lookup-0.1.0rc0/LICENSE

@@ -0,0 +1,216 @@
+Copyright 2022 Battelle Memorial Institute
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy
+of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
+
+
+                                  Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

volttron_platform_lookup-0.1.0rc0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.3
+Name: volttron-platform-lookup
+Version: 0.1.0rc0
+Summary: Web service that runs outside of VOLTTRON server and let VOLTTRON instance to register itself and lookup for services that can be part of a federated group
+License: Apache-2.0
+Author: volttron
+Author-email: volttron@pnnl.gov
+Requires-Python: >=3.9
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: fastapi (>=0.118.0)
+Requires-Dist: uvicorn (>=0.37.0)
+Project-URL: Documentation, https://github.com/eclipse-volttron/platform-lookup
+Project-URL: Repository, https://github.com/eclipse-volttron/platform-lookup
+Description-Content-Type: text/markdown
+
+# Platform Lookup Service
+
+A FastAPI-based microservice for managing platform registrations and lookups. This service provides a RESTful API for registering and managing platforms with their associated credentials and network addresses.
+
+## Features
+
+- Platform registration and management
+- Thread-safe operations for concurrent access
+- Input validation using Pydantic models
+- Support for platform grouping
+- JSON-based persistent storage
+- RESTful API with OpenAPI documentation
+
+## Requirements
+
+- Python 3.x
+- FastAPI
+- Uvicorn
+
+## Installation
+
+1. From pypi
+  
+   ```bash
+   pip install volttron-platform-lookup
+   ```
+
+1. From source code:
+
+   ```bash
+   git clone [repository-url]
+   cd platform-lookup
+   poetry install
+   ```
+
+
+## Usage
+
+1. Start the server:
+
+   ```bash
+   volttron-platform-lookup <optional port. defaults to 8000>
+   ```
+
+2. The API will be available at `http://localhost:8000`
+3. Access the API documentation at `http://localhost:8000/docs`
+
+## API Endpoints
+
+The service provides RESTful endpoints for platform management. All data is exchanged in JSON format.
+
+### Platform Model
+
+Each platform registration includes:
+
+- `id`: Unique identifier for the platform (alphanumeric, underscores, and hyphens allowed)
+- `address`: Network address where the platform can be reached (IP, domain, or URI)
+- `public_credentials`: Authentication credential (minimum 16 characters)
+- `group`: Optional grouping parameter (defaults to "default")
+
+Example platform registration:
+
+```json
+{
+    "id": "platform-123",
+    "address": "tcp://example.com",
+    "public_credentials": "abcdef1234567890",
+    "group": "production"
+}
+```
+
+## Data Storage
+
+Platform data is stored in `platforms.json` with thread-safe access mechanisms to prevent race conditions during concurrent operations.
+
+## Security
+
+- Input validation for all API endpoints
+- Credential length requirements
+- Address format validation
+- Thread-safe operations
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Submit a pull request
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
+
+Copyright 2025 Battelle Memorial Institute
+
+## Disclaimer Notice
+
+This material was prepared as an account of work sponsored by an agency of the
+United States Government.  Neither the United States Government nor the United
+States Department of Energy, nor Battelle, nor any of their employees, nor any
+jurisdiction or organization that has cooperated in the development of these
+materials, makes any warranty, express or implied, or assumes any legal
+liability or responsibility for the accuracy, completeness, or usefulness or any
+information, apparatus, product, software, or process disclosed, or represents
+that its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service by
+trade name, trademark, manufacturer, or otherwise does not necessarily
+constitute or imply its endorsement, recommendation, or favoring by the United
+States Government or any agency thereof, or Battelle Memorial Institute. The
+views and opinions of authors expressed herein do not necessarily state or
+reflect those of the United States Government or any agency thereof.
+

volttron_platform_lookup-0.1.0rc0/README.md

@@ -0,0 +1,111 @@
+# Platform Lookup Service
+
+A FastAPI-based microservice for managing platform registrations and lookups. This service provides a RESTful API for registering and managing platforms with their associated credentials and network addresses.
+
+## Features
+
+- Platform registration and management
+- Thread-safe operations for concurrent access
+- Input validation using Pydantic models
+- Support for platform grouping
+- JSON-based persistent storage
+- RESTful API with OpenAPI documentation
+
+## Requirements
+
+- Python 3.x
+- FastAPI
+- Uvicorn
+
+## Installation
+
+1. From pypi
+  
+   ```bash
+   pip install volttron-platform-lookup
+   ```
+
+1. From source code:
+
+   ```bash
+   git clone [repository-url]
+   cd platform-lookup
+   poetry install
+   ```
+
+
+## Usage
+
+1. Start the server:
+
+   ```bash
+   volttron-platform-lookup <optional port. defaults to 8000>
+   ```
+
+2. The API will be available at `http://localhost:8000`
+3. Access the API documentation at `http://localhost:8000/docs`
+
+## API Endpoints
+
+The service provides RESTful endpoints for platform management. All data is exchanged in JSON format.
+
+### Platform Model
+
+Each platform registration includes:
+
+- `id`: Unique identifier for the platform (alphanumeric, underscores, and hyphens allowed)
+- `address`: Network address where the platform can be reached (IP, domain, or URI)
+- `public_credentials`: Authentication credential (minimum 16 characters)
+- `group`: Optional grouping parameter (defaults to "default")
+
+Example platform registration:
+
+```json
+{
+    "id": "platform-123",
+    "address": "tcp://example.com",
+    "public_credentials": "abcdef1234567890",
+    "group": "production"
+}
+```
+
+## Data Storage
+
+Platform data is stored in `platforms.json` with thread-safe access mechanisms to prevent race conditions during concurrent operations.
+
+## Security
+
+- Input validation for all API endpoints
+- Credential length requirements
+- Address format validation
+- Thread-safe operations
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Submit a pull request
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
+
+Copyright 2025 Battelle Memorial Institute
+
+## Disclaimer Notice
+
+This material was prepared as an account of work sponsored by an agency of the
+United States Government.  Neither the United States Government nor the United
+States Department of Energy, nor Battelle, nor any of their employees, nor any
+jurisdiction or organization that has cooperated in the development of these
+materials, makes any warranty, express or implied, or assumes any legal
+liability or responsibility for the accuracy, completeness, or usefulness or any
+information, apparatus, product, software, or process disclosed, or represents
+that its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service by
+trade name, trademark, manufacturer, or otherwise does not necessarily
+constitute or imply its endorsement, recommendation, or favoring by the United
+States Government or any agency thereof, or Battelle Memorial Institute. The
+views and opinions of authors expressed herein do not necessarily state or
+reflect those of the United States Government or any agency thereof.

volttron_platform_lookup-0.1.0rc0/platform_lookup/app.py

@@ -0,0 +1,320 @@
+import json
+import sys
+from threading import Lock
+from fastapi import FastAPI, HTTPException, Depends, Request, Response
+from pydantic import BaseModel, Field, field_validator
+from typing import List, Optional
+
+app = FastAPI(
+    title="Platform Management API",
+    description="API for managing platform registrations",
+    version="1.0.0"
+)
+
+platform_file = "platforms.json"
+lock = Lock()
+DEFAULT_GROUP = "default"
+
+class PlatformWithIP(BaseModel):
+    """Internal model for storing platform data with IP tracking"""
+    id: str
+    address: str
+    public_credentials: str
+    group: str
+    last_modified_ip: Optional[str] = None
+
+    def to_platform(self) -> "Platform":
+        """Convert to Platform model (excluding last_modified_ip)"""
+        return Platform(
+            id=self.id,
+            address=self.address,
+            public_credentials=self.public_credentials,
+            group=self.group
+        )
+
+class Platform(BaseModel):
+    id: str = Field(...,
+                    description="""
+                    # Unique id for the platform.
+
+                    When external platforms refer to an agent on this platform they will use this as a prefix
+                    to allow routing of messages to go to the proper location.
+                    Only alphanumeric characters, underscores, and hyphens are allowed.
+                    The id must be unique across all platforms.
+                    """)
+    address: str = Field(...,
+                    description="""
+                    # Address of the platform.
+
+                    This is the address where the platform can be reached.
+                    It can be an IP address, a domain name, or a URI.
+                    """)
+    public_credentials: str = Field(...,
+                    description="""
+                    # Public credential for the platform.
+                    This is the credential that will be used to authenticate with the platform.  For zmq this
+                    is the publickey of the server to allow a client to connect to the zap loop.  This may be
+                    different for other protocols.
+                    """)
+    group: str = Field(default=DEFAULT_GROUP,
+                    description="""
+                    # Group of the platform.
+
+                    This is the group that the platform belongs to.  It is used to group platforms together for
+                    routing purposes.  If not specified, the platform will be added to the default group.
+
+                    This will allow partitioning of platforms in the future.
+                    """)
+    @field_validator('address')
+    @classmethod
+    def address_must_be_valid(cls, v):
+        """Validate that address has a valid format"""
+        # Simple URL or IP check - you might want to use proper validation libraries
+        import re
+        # Basic check for IP or URL-like string
+        if not (v.startswith(('http://', 'https://', 'tcp://', 'ipc://')) or
+                re.match(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(:\d+)?$', v)):
+            raise ValueError("Address must be a valid URL, IP address, or protocol URI")
+        return v
+
+    @field_validator('public_credentials')
+    @classmethod
+    def credential_must_be_valid(cls, v):
+        """Validate credential format"""
+        if len(v) < 16:  # Example minimum length requirement
+            raise ValueError("Public credential must be at least 16 characters long")
+        return v
+
+    model_config = {
+        "json_schema_extra": {
+            "examples": [
+                {
+                    "id": "platform-123",
+                    "address": "tcp://example.com",
+                    "public_credentials": "abcdef1234567890",
+                    "group": "production"
+                }
+            ]
+        }
+    }
+
+def get_platforms():
+    """Dependency to get platforms with thread safety"""
+    with lock:
+        return _load_platforms()
+
+def _store_platforms(platforms):
+    """Save platforms to file with proper JSON serialization"""
+    # Convert to dict for JSON serialization
+    platforms_json = [p.dict() for p in platforms]
+    with lock:
+        with open(platform_file, "w") as f:
+            json.dump(platforms_json, f, indent=2)
+
+def _load_platforms():
+    """Load platforms from file with proper deserialization"""
+    try:
+        with open(platform_file, "r") as f:
+            platforms_data = json.load(f)
+            return [PlatformWithIP(**p) for p in platforms_data]
+    except FileNotFoundError:
+        return []
+
+def _get_client_ip(request: Request) -> str:
+    """Extract client IP address from request"""
+    # Check for forwarded headers first (in case of proxy/load balancer)
+    forwarded_for = request.headers.get("X-Forwarded-For")
+    if forwarded_for:
+        # Take the first IP if there are multiple
+        return forwarded_for.split(",")[0].strip()
+
+    real_ip = request.headers.get("X-Real-IP")
+    if real_ip:
+        return real_ip
+
+    # Fall back to direct client IP
+    return request.client.host if request.client else "unknown"
+
+@app.get("/", tags=["Root"])
+async def root():
+    """API root endpoint"""
+    return {"message": app.title, "version": app.version}
+
+@app.post("/platform", response_model=Platform, tags=["Platforms"])
+async def register_platform(platform: Platform, request: Request, response: Response):
+    """
+    Register a new platform
+
+    This endpoint allows you to register a new platform with the system.
+
+    The following fields must be unique across all platforms:
+    - id: The platform's unique identifier
+    - address: The platform's network address
+    - public_credentials: The platform's public authentication credential
+
+    Returns:
+    - 200: If the same IP submits identical platform data
+    - 201: If new platform is created or existing platform is updated
+    """
+    platforms = get_platforms()
+    client_ip = _get_client_ip(request)
+
+    # Check if platform already exists
+    for i, existing_platform in enumerate(platforms):
+        if existing_platform.id == platform.id:
+            # Check if this is the same request from the same IP
+            if (existing_platform.last_modified_ip == client_ip and
+                existing_platform.address == platform.address and
+                existing_platform.public_credentials == platform.public_credentials and
+                existing_platform.group == platform.group):
+                # Same data from same IP - return 200
+                response.status_code = 200
+                return existing_platform.to_platform()
+
+            # Different data or different IP - check for conflicts with other platforms
+            for j, other_platform in enumerate(platforms):
+                if j != i:  # Skip the current platform being updated
+                    if other_platform.address == platform.address:
+                        raise HTTPException(status_code=400, detail=f"Platform with address '{platform.address}' already exists")
+                    if other_platform.public_credentials == platform.public_credentials:
+                        raise HTTPException(status_code=400, detail=f"Platform with public credential '{platform.public_credentials}' already exists")
+
+            # Update existing platform
+            platforms[i] = PlatformWithIP(
+                id=platform.id,
+                address=platform.address,
+                public_credentials=platform.public_credentials,
+                group=platform.group,
+                last_modified_ip=client_ip
+            )
+            _store_platforms(platforms)
+            response.status_code = 201
+            return platforms[i].to_platform()
+
+    # Check for duplicate address or credentials with existing platforms
+    if any(p.address == platform.address for p in platforms):
+        raise HTTPException(status_code=400, detail=f"Platform with address '{platform.address}' already exists")
+
+    if any(p.public_credentials == platform.public_credentials for p in platforms):
+        raise HTTPException(status_code=400, detail=f"Platform with public credential '{platform.public_credentials}' already exists")
+
+    # Create new platform
+    new_platform = PlatformWithIP(
+        id=platform.id,
+        address=platform.address,
+        public_credentials=platform.public_credentials,
+        group=platform.group,
+        last_modified_ip=client_ip
+    )
+    platforms.append(new_platform)
+    _store_platforms(platforms)
+    response.status_code = 201
+    return new_platform.to_platform()
+
+@app.get("/platform/{platform_id}", response_model=Platform, tags=["Platforms"])
+async def read_platform(platform_id: str, platforms: List[PlatformWithIP] = Depends(get_platforms)):
+    """
+    Get platform details by ID
+
+    Retrieve detailed information about a specific platform
+    """
+    for platform in platforms:
+        if platform.id == platform_id:
+            return platform.to_platform()
+    raise HTTPException(status_code=404, detail=f"Platform with ID '{platform_id}' not found")
+
+@app.put("/platform/{platform_id}", response_model=Platform, tags=["Platforms"])
+async def update_platform(platform_id: str, updated_platform: Platform, request: Request, response: Response):
+    """
+    Update platform information
+
+    Update an existing platform's details
+
+    Returns:
+    - 200: If the same IP submits identical platform data
+    - 201: If platform is updated with new data
+    """
+    platforms = get_platforms()
+    client_ip = _get_client_ip(request)
+
+    for i, platform in enumerate(platforms):
+        if platform.id == platform_id:
+            # Ensure ID doesn't change
+            if updated_platform.id != platform_id:
+                raise HTTPException(status_code=400, detail="Cannot change platform ID")
+
+            # Check if this is the same request from the same IP
+            if (platform.last_modified_ip == client_ip and
+                platform.address == updated_platform.address and
+                platform.public_credentials == updated_platform.public_credentials and
+                platform.group == updated_platform.group):
+                # Same data from same IP - return 200
+                response.status_code = 200
+                return Platform(**platform.dict(exclude={'last_modified_ip'}))
+
+            # Check for conflicts with other platforms (excluding current one)
+            for j, other_platform in enumerate(platforms):
+                if j != i:  # Skip the current platform being updated
+                    if other_platform.address == updated_platform.address:
+                        raise HTTPException(status_code=400, detail=f"Platform with address '{updated_platform.address}' already exists")
+                    if other_platform.public_credentials == updated_platform.public_credentials:
+                        raise HTTPException(status_code=400, detail=f"Platform with public credential '{updated_platform.public_credentials}' already exists")
+
+            # Update platform
+            platforms[i] = PlatformWithIP(
+                id=updated_platform.id,
+                address=updated_platform.address,
+                public_credentials=updated_platform.public_credentials,
+                group=updated_platform.group,
+                last_modified_ip=client_ip
+            )
+            _store_platforms(platforms)
+            response.status_code = 201
+            return Platform(**platforms[i].dict(exclude={'last_modified_ip'}))
+
+    raise HTTPException(status_code=404, detail=f"Platform with ID '{platform_id}' not found")
+
+@app.delete("/platform/{platform_id}", tags=["Platforms"])
+async def delete_platform(platform_id: str):
+    """
+    Delete a platform
+
+    Remove a platform from the system
+    """
+    platforms = get_platforms()
+    initial_count = len(platforms)
+
+    platforms = [p for p in platforms if p.id != platform_id]
+
+    if len(platforms) == initial_count:
+        raise HTTPException(status_code=404, detail=f"Platform with ID '{platform_id}' not found")
+
+    _store_platforms(platforms)
+    return {"message": f"Platform '{platform_id}' deleted successfully"}
+
+@app.get("/platforms", response_model=List[Platform], tags=["Platforms"])
+async def list_platforms(platforms: List[PlatformWithIP] = Depends(get_platforms)):
+    """
+    List all platforms
+
+    Get a list of all registered platforms
+    """
+    return [p.to_platform() for p in platforms]
+
+def main():
+     # Default port
+    port = 8000
+
+    # Check if a custom port is provided as a command-line argument
+    if len(sys.argv) > 1:
+        try:
+            port = int(sys.argv[1])
+        except ValueError:
+            print("Invalid port number. Using default port 8000.")
+
+    import uvicorn
+    uvicorn.run("platform_lookup.app:app", host="0.0.0.0", port=port)
+
+if __name__ == "__main__":
+    main()
+

volttron_platform_lookup-0.1.0rc0/pyproject.toml

@@ -0,0 +1,24 @@
+[tool.poetry]
+name = "volttron-platform-lookup"
+version = "0.1.0rc0"
+description = "Web service that runs outside of VOLTTRON server and let VOLTTRON instance to register itself and lookup for services that can be part of a federated group"
+authors = [ "volttron <volttron@pnnl.gov>"]
+license = "Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/eclipse-volttron/platform-lookup"
+documentation =  "https://github.com/eclipse-volttron/platform-lookup"
+packages = [
+    { include = "platform_lookup", from = "." }
+]
+
+[tool.poetry.scripts]
+volttron-platform-lookup = "platform_lookup.app:main"
+
+[tool.poetry.dependencies]
+python = ">=3.9"
+fastapi = ">=0.118.0"
+uvicorn = ">=0.37.0"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"