hummingbot-api-client 1.0.0__tar.gz

hummingbot_api_client-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

hummingbot_api_client-1.0.0/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: hummingbot-api-client
+Version: 1.0.0
+Summary: An async Python client for Hummingbot API
+Author-email: Federico Cardoso <federico.cardoso.e@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/hummingbot/hummingbot-client
+Project-URL: Documentation, https://github.com/hummingbot/hummingbot-client#readme
+Project-URL: Repository, https://github.com/hummingbot/hummingbot-client
+Project-URL: Issues, https://github.com/hummingbot/hummingbot-client/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Dynamic: license-file
+
+# hummingbot-client
+
+An async Python client for the Hummingbot API with modular router support.
+
+## Installation
+
+```bash
+# Using uv (recommended)
+uv venv && source .venv/bin/activate
+uv pip install aiohttp
+
+# Or using pip
+pip install aiohttp
+
+# Install the package
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import asyncio
+from hummingbot_api_client import HummingbotAPIClient
+
+
+async def main():
+  # Using context manager (recommended)
+  async with HummingbotAPIClient("http://localhost:8000", "admin", "admin") as client:
+    # Get portfolio state
+    portfolio = await client.portfolio.get_state()
+    print(f"Portfolio value: ${sum(b['value'] for a in portfolio.values() for c in a.values() for b in c):.2f}")
+
+    # List available connectors
+    connectors = await client.connectors.list_connectors()
+    print(f"Available connectors: {len(connectors)}")
+
+    # Check Docker status
+    docker_status = await client.docker.is_running()
+    print(f"Docker running: {docker_status['is_docker_running']}")
+
+
+asyncio.run(main())
+```
+
+## Prerequisites
+
+Before using the client, ensure:
+
+1. The Hummingbot API is running on `http://localhost:8000` (default)
+2. Authentication credentials are configured (default: `admin:admin`)
+3. Docker is running (for Docker-related operations)
+4. Required dependencies are installed
+
+## API Client Features
+
+The client provides access to all Hummingbot API functionality through specialized routers:
+
+### Core Routers
+
+- **🐳 Docker** (`client.docker`): Container and image management
+  - List/start/stop containers
+  - Pull images with progress monitoring
+  - Clean up exited containers
+
+- **👤 Accounts** (`client.accounts`): Account and credential management
+  - Create/delete accounts
+  - Manage exchange credentials
+  - List configured connectors per account
+
+- **💰 Trading** (`client.trading`): Order and position management
+  - Place/cancel orders
+  - Monitor positions and PnL
+  - Access trade history with pagination
+  - Configure perpetual trading modes
+
+- **💼 Portfolio** (`client.portfolio`): Portfolio monitoring and analysis
+  - Real-time portfolio state
+  - Token and account distribution
+  - Historical portfolio tracking
+
+- **🔌 Connectors** (`client.connectors`): Exchange connector information
+  - List available connectors
+  - Get configuration requirements
+  - Access trading rules and order types
+
+### Bot Management Routers
+
+- **🤖 Bot Orchestration** (`client.bot_orchestration`): Bot lifecycle management
+  - Start/stop bots
+  - Deploy strategies
+  - Monitor bot status via MQTT
+
+- **📋 Controllers** (`client.controllers`): Advanced strategy controllers
+- **📜 Scripts** (`client.scripts`): Traditional Hummingbot scripts
+- **📊 Backtesting** (`client.backtesting`): Strategy backtesting
+- **🗄️ Archived Bots** (`client.archived_bots`): Analysis of stopped bots
+- **📈 Markets** (`client.markets`): Market data and candles
+
+## Examples
+
+### Basic Examples
+
+The `examples/` directory contains comprehensive examples for each router:
+
+```bash
+# Basic usage demonstrating all features
+python examples/basic_usage.py
+
+# Router-specific examples
+python examples/docker_example.py
+python examples/accounts_example.py
+python examples/trading_example.py
+# ... and more
+```
+
+### Interactive Test Scripts
+
+Comprehensive test scripts with step-by-step demonstrations:
+
+```bash
+# Run in automatic mode
+python examples/docker_example.py
+python examples/accounts_example.py
+python examples/trading_example.py
+python examples/portfolio_example.py
+python examples/connectors_example.py
+
+# Run in interactive mode (with explanations)
+python examples/docker_example.py --interactive
+```
+
+Each test script demonstrates the complete functionality of its router with real API calls.
+
+## Advanced Usage
+
+### Error Handling
+
+```python
+async with HummingbotClient("http://localhost:8000", "admin", "admin") as client:
+    try:
+        orders = await client.trading.search_orders({"limit": 10})
+        print(f"Found {len(orders['data'])} orders")
+    except aiohttp.ClientResponseError as e:
+        print(f"API error: {e.status} - {e.message}")
+    except Exception as e:
+        print(f"Unexpected error: {e}")
+```
+
+### Pagination
+
+```python
+async def get_all_orders(client):
+    """Fetch all orders using pagination."""
+    all_orders = []
+    cursor = None
+    
+    while True:
+        filter_request = {"limit": 100}
+        if cursor:
+            filter_request["cursor"] = cursor
+            
+        response = await client.trading.search_orders(filter_request)
+        all_orders.extend(response["data"])
+        
+        pagination = response["pagination"]
+        if not pagination["has_more"]:
+            break
+            
+        cursor = pagination["next_cursor"]
+    
+    return all_orders
+```
+
+### Custom Timeout
+
+```python
+import aiohttp
+
+# Create client with custom timeout
+timeout = aiohttp.ClientTimeout(total=60)  # 60 seconds
+client = HummingbotClient(
+    "http://localhost:8000",
+    "admin",
+    "admin",
+    timeout=timeout
+)
+```
+
+## Building
+
+```bash
+# Install build dependencies
+uv pip install build
+
+# Build the package
+python -m build
+
+# Install in development mode
+pip install -e .
+```
+
+## License
+
+Apache License 2.0

hummingbot_api_client-1.0.0/README.md

@@ -0,0 +1,204 @@
+# hummingbot-client
+
+An async Python client for the Hummingbot API with modular router support.
+
+## Installation
+
+```bash
+# Using uv (recommended)
+uv venv && source .venv/bin/activate
+uv pip install aiohttp
+
+# Or using pip
+pip install aiohttp
+
+# Install the package
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import asyncio
+from hummingbot_api_client import HummingbotAPIClient
+
+
+async def main():
+  # Using context manager (recommended)
+  async with HummingbotAPIClient("http://localhost:8000", "admin", "admin") as client:
+    # Get portfolio state
+    portfolio = await client.portfolio.get_state()
+    print(f"Portfolio value: ${sum(b['value'] for a in portfolio.values() for c in a.values() for b in c):.2f}")
+
+    # List available connectors
+    connectors = await client.connectors.list_connectors()
+    print(f"Available connectors: {len(connectors)}")
+
+    # Check Docker status
+    docker_status = await client.docker.is_running()
+    print(f"Docker running: {docker_status['is_docker_running']}")
+
+
+asyncio.run(main())
+```
+
+## Prerequisites
+
+Before using the client, ensure:
+
+1. The Hummingbot API is running on `http://localhost:8000` (default)
+2. Authentication credentials are configured (default: `admin:admin`)
+3. Docker is running (for Docker-related operations)
+4. Required dependencies are installed
+
+## API Client Features
+
+The client provides access to all Hummingbot API functionality through specialized routers:
+
+### Core Routers
+
+- **🐳 Docker** (`client.docker`): Container and image management
+  - List/start/stop containers
+  - Pull images with progress monitoring
+  - Clean up exited containers
+
+- **👤 Accounts** (`client.accounts`): Account and credential management
+  - Create/delete accounts
+  - Manage exchange credentials
+  - List configured connectors per account
+
+- **💰 Trading** (`client.trading`): Order and position management
+  - Place/cancel orders
+  - Monitor positions and PnL
+  - Access trade history with pagination
+  - Configure perpetual trading modes
+
+- **💼 Portfolio** (`client.portfolio`): Portfolio monitoring and analysis
+  - Real-time portfolio state
+  - Token and account distribution
+  - Historical portfolio tracking
+
+- **🔌 Connectors** (`client.connectors`): Exchange connector information
+  - List available connectors
+  - Get configuration requirements
+  - Access trading rules and order types
+
+### Bot Management Routers
+
+- **🤖 Bot Orchestration** (`client.bot_orchestration`): Bot lifecycle management
+  - Start/stop bots
+  - Deploy strategies
+  - Monitor bot status via MQTT
+
+- **📋 Controllers** (`client.controllers`): Advanced strategy controllers
+- **📜 Scripts** (`client.scripts`): Traditional Hummingbot scripts
+- **📊 Backtesting** (`client.backtesting`): Strategy backtesting
+- **🗄️ Archived Bots** (`client.archived_bots`): Analysis of stopped bots
+- **📈 Markets** (`client.markets`): Market data and candles
+
+## Examples
+
+### Basic Examples
+
+The `examples/` directory contains comprehensive examples for each router:
+
+```bash
+# Basic usage demonstrating all features
+python examples/basic_usage.py
+
+# Router-specific examples
+python examples/docker_example.py
+python examples/accounts_example.py
+python examples/trading_example.py
+# ... and more
+```
+
+### Interactive Test Scripts
+
+Comprehensive test scripts with step-by-step demonstrations:
+
+```bash
+# Run in automatic mode
+python examples/docker_example.py
+python examples/accounts_example.py
+python examples/trading_example.py
+python examples/portfolio_example.py
+python examples/connectors_example.py
+
+# Run in interactive mode (with explanations)
+python examples/docker_example.py --interactive
+```
+
+Each test script demonstrates the complete functionality of its router with real API calls.
+
+## Advanced Usage
+
+### Error Handling
+
+```python
+async with HummingbotClient("http://localhost:8000", "admin", "admin") as client:
+    try:
+        orders = await client.trading.search_orders({"limit": 10})
+        print(f"Found {len(orders['data'])} orders")
+    except aiohttp.ClientResponseError as e:
+        print(f"API error: {e.status} - {e.message}")
+    except Exception as e:
+        print(f"Unexpected error: {e}")
+```
+
+### Pagination
+
+```python
+async def get_all_orders(client):
+    """Fetch all orders using pagination."""
+    all_orders = []
+    cursor = None
+    
+    while True:
+        filter_request = {"limit": 100}
+        if cursor:
+            filter_request["cursor"] = cursor
+            
+        response = await client.trading.search_orders(filter_request)
+        all_orders.extend(response["data"])
+        
+        pagination = response["pagination"]
+        if not pagination["has_more"]:
+            break
+            
+        cursor = pagination["next_cursor"]
+    
+    return all_orders
+```
+
+### Custom Timeout
+
+```python
+import aiohttp
+
+# Create client with custom timeout
+timeout = aiohttp.ClientTimeout(total=60)  # 60 seconds
+client = HummingbotClient(
+    "http://localhost:8000",
+    "admin",
+    "admin",
+    timeout=timeout
+)
+```
+
+## Building
+
+```bash
+# Install build dependencies
+uv pip install build
+
+# Build the package
+python -m build
+
+# Install in development mode
+pip install -e .
+```
+
+## License
+
+Apache License 2.0

hummingbot_api_client-1.0.0/hummingbot_api_client/__init__.py

@@ -0,0 +1,4 @@
+from .client import HummingbotAPIClient
+
+__version__ = "0.1.0"
+__all__ = ["HummingbotAPIClient"]