Merge pull request #381 from binance/modularize_connectors

Author: alplabin

.gitignore

@@ -1,6 +1,6 @@
 build
 dist
-binance_connector.egg-info/
+
 __pycache__
 *.pyc
 .tox

MIGRATION.md

@@ -6,7 +6,7 @@ With the move towards modularization, Binance connectors are now split into smal
 
 | Feature | Monolithic Connector | Modular Connector |
 |---------|----------------------|------------------|
-| Package Name | `binance-connector` | `binance-<product>` |
+| Package Name | `binance-connector` | `binance-sdk-<product>` |
 | API Coverage | All Binance APIs | Individual APIs (Spot, Wallet, Algo Trading, Mining, etc.) |
 | Imports | Single package import | Separate package per product |
 | Code Structure | One large client | Smaller, focused clients |
@@ -26,13 +26,13 @@ pip uninstall binance-connector
 Install only the connector(s) you need. For example, to install the Spot Trading connector:
 
 ```bash
-pip install binance-spot
+pip install binance-sdk-spot
 ```
 
 To install multiple connectors:
 
 ```bash
-pip install binance-spot binance-margin-trading binance-wallet
+pip install binance-sdk-spot binance-sdk-margin-trading binanc-sdk-wallet
 ```
 
 ### **Step 3: Update Imports**
@@ -49,7 +49,7 @@ from binance.spot import Spot
 **New:**
 
 ```python
-from spot import Spot
+from binance_sdk_spot.spot import Spot
 ```
 
 ### **Step 4: Update Client Initialization**
@@ -69,8 +69,8 @@ print(account_info)
 **New (Modular Spot Connector):**
 
 ```python
-from spot import Spot
-from spot.rest_api.configuration import ConfigurationRestAPI
+from binance_common.configuration import ConfigurationRestAPI
+from binance_sdk_spot.spot import Spot
 
 configuration = ConfigurationRestAPI(api_key, api_secret)
 client = Spot(config_rest_api=configuration)

README.md

@@ -6,43 +6,43 @@
 [![Known Vulnerabilities](https://snyk.io/test/github/binance/binance-connector-python/badge.svg)](https://snyk.io/test/github/binance/binance-connector-python)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Collection of auto-generated Python connectors for Binance APIs.
+Collection of auto-generated Python SDK for Binance APIs.
 
 ## Prerequisites
 
-Before using the connectors, ensure you have:
+Before using the SDK, ensure you have:
 
 - **Python** (version 3.9 or later)
 - **pip** (Python package manager)
-- **poetry** ()
-
-
-## Available Connectors
-
-- [binance-algo](./clients/algo) - Algo Trading connector
-- [binance-c2c](./clients/c2c/) - C2C connector
-- [binance-convert](./clients/convert/) - Convert connector
-- [binance-copy-trading](./clients/copy_trading/) - Copy Trading connector
-- [binance-crypto-loan](./clients/crypto_loan/) - Crypto Loan connector
-- [binance-derivatives-trading-coin-futures](./clients/derivatives_trading_coin_futures/) - Coin Futures Trading connector
-- [binance-derivatives-trading-options](./clients/derivatives_trading_options/) - Options Trading connector
-- [binance-derivatives-trading-portfolio-margin](./clients/derivatives_trading_portfolio_margin/) - Portfolio Margin Futures Trading connector
-- [binance-derivatives-trading-portfolio-margin-pro](./clients/derivatives_trading_portfolio_margin_pro/) - Portfolio Margin Pro Trading connector
-- [binance-derivatives-trading-usds-futures](./clients/derivatives_trading_usds_futures/) - USDs Futures Trading connector
-- [binance-dual-investment](./clients/dual_investment/) - Dual Investment connector
-- [binance-fiat](./clients/fiat/) - Fiat connector
-- [binance-gift-card](./clients/gift_card/) - Gift Card connector
-- [binance-margin-trading](./clients/margin_trading/) - Margin Trading connector
-- [binance-mining](./clients/mining/) - Mining connector
-- [binance-nft](./clients/nft/) - NFT connector
-- [binance-pay](./clients/pay/) - Pay connector
-- [binance-rebate](./clients/rebate/) - Rebate connector
-- [binance-simple-earn](./clients/simple_earn/) - Simple Earn connector
-- [binance-spot](./clients/spot/) - Spot Trading connector
-- [binance-staking](./clients/staking/) - Staking connector
-- [binance-sub-account](./clients/sub_account/) - Sub Account connector
-- [binance-vip-loan](./clients/vip_loan/) - VIP Loan connector
-- [binance-wallet](./clients/wallet/) - Wallet connector
+- **poetry** (Python package manager)
+
+
+## Available SDK
+
+- [binance-sdk-algo](./clients/algo) - Algo Trading connector
+- [binance-sdk-c2c](./clients/c2c/) - C2C connector
+- [binance-sdk-convert](./clients/convert/) - Convert connector
+- [binance-sdk-copy-trading](./clients/copy_trading/) - Copy Trading connector
+- [binance-sdk-crypto-loan](./clients/crypto_loan/) - Crypto Loan connector
+- [binance-sdk-derivatives-trading-coin-futures](./clients/derivatives_trading_coin_futures/) - Coin Futures Trading connector
+- [binance-sdk-derivatives-trading-options](./clients/derivatives_trading_options/) - Options Trading connector
+- [binance-sdk-derivatives-trading-portfolio-margin](./clients/derivatives_trading_portfolio_margin/) - Portfolio Margin Futures Trading connector
+- [binance-sdk-derivatives-trading-portfolio-margin-pro](./clients/derivatives_trading_portfolio_margin_pro/) - Portfolio Margin Pro Trading connector
+- [binance-sdk-derivatives-trading-usds-futures](./clients/derivatives_trading_usds_futures/) - USDs Futures Trading connector
+- [binance-sdk-dual-investment](./clients/dual_investment/) - Dual Investment connector
+- [binance-sdk-fiat](./clients/fiat/) - Fiat connector
+- [binance-sdk-gift-card](./clients/gift_card/) - Gift Card connector
+- [binance-sdk-margin-trading](./clients/margin_trading/) - Margin Trading connector
+- [binance-sdk-mining](./clients/mining/) - Mining connector
+- [binance-sdk-nft](./clients/nft/) - NFT connector
+- [binance-sdk-pay](./clients/pay/) - Pay connector
+- [binance-sdk-rebate](./clients/rebate/) - Rebate connector
+- [binance-sdk-simple-earn](./clients/simple_earn/) - Simple Earn connector
+- [binance-sdk-spot](./clients/spot/) - Spot Trading connector
+- [binance-sdk-staking](./clients/staking/) - Staking connector
+- [binance-sdk-sub-account](./clients/sub_account/) - Sub Account connector
+- [binance-sdk-vip-loan](./clients/vip_loan/) - VIP Loan connector
+- [binance-sdk-wallet](./clients/wallet/) - Wallet connector
 
 ## Documentation
 
@@ -53,21 +53,21 @@ For detailed information, refer to the [Binance API Documentation](https://devel
 Each connector is published as a separate Python package. You can install them via `pip` or `poetry`. For example:
 
 ```bash
-pip install binance-spot
+pip install binance-sdk-spot
 ```
 
 ```bash
-poetry add binance-spot
+poetry add binance-sdk-spot
 ```
 
 Or to install multiple connectors:
 
 ```bash
-pip install binance-spot binance-margin-trading binance-staking
+pip install binance-sdk-spot binance-sdk-margin-trading binance-sdk-staking
 ```
 
 ```bash
-poetry add binance-spot binance-margin-trading binance-staking
+poetry add binance-sdk-spot binance-sdk-margin-trading binance-sdk-staking
 ```
 
 ## Contributing

clients/algo/.gitignore

@@ -1,6 +1,6 @@
 build
 dist
-binance_connector.egg-info/
+
 __pycache__
 *.pyc
 .tox

clients/algo/CHANGELOG.md

@@ -1,5 +1,5 @@
 # Changelog
 
-## 1.0.0 - 2025-07-16
+## 1.0.0 - 2025-07-17
 
 - Initial release

clients/algo/README.md

@@ -1,16 +1,16 @@
-# Binance Python Algo Connector
+# Binance Python Algo SDK
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/binance/binance-connector-python/ci-algo.yml)](https://github.com/binance/binance-connector-python/actions)
 [![Open Issues](https://img.shields.io/github/issues/binance/binance-connector-python)](https://github.com/binance/binance-connector-python/issues)
 [![Code Style: Black](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
-[![PyPI version](https://img.shields.io/pypi/v/binance-algo)](https://pypi.python.org/pypi/binance-algo)
-[![PyPI Downloads](https://img.shields.io/pypi/dm/binance-algo.svg)](https://pypi.org/project/binance-algo/)
+[![PyPI version](https://img.shields.io/pypi/v/binance-sdk-algo)](https://pypi.python.org/pypi/binance-sdk-algo)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/binance-sdk-algo.svg)](https://pypi.org/project/binance-sdk-algo/)
 [![Python version](https://img.shields.io/pypi/pyversions/binance-connector)](https://www.python.org/downloads/)
 [![Known Vulnerabilities](https://img.shields.io/badge/security-scanned-brightgreen)](https://github.com/binance/binance-connector-python/security)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-This is a client library for the Binance Algo API, enabling developers to interact programmatically with Binance's Algo trading platform. The library provides tools to programmatically leverage Binance in-house algorithmic trading capability to automate order execution strategy, improve execution transparency and give users smart access to the available market liquidity through the REST API:
-- [REST API](./src/binance_algo/rest_api/rest_api.py)
+This is a client library for the Binance Algo SDK API, enabling developers to interact programmatically with Binance's Algo trading platform. The library provides tools to programmatically leverage Binance in-house algorithmic trading capability to automate order execution strategy, improve execution transparency and give users smart access to the available market liquidity through the REST API:
+- [REST API](./src/binance_sdk_algo/rest_api/rest_api.py)
 
 ## Table of Contents
 
@@ -19,7 +19,6 @@ This is a client library for the Binance Algo API, enabling developers to intera
 - [Documentation](#documentation)
 - [REST APIs](#rest-apis)
 - [Testing](#testing)
-- [Migration Guide](#migration-guide)
 - [Contributing](#contributing)
 - [Licence](#licence)
 
@@ -34,7 +33,7 @@ This is a client library for the Binance Algo API, enabling developers to intera
 To use this library, ensure your environment is running Python version **3.9** or later.
 
 ```bash
-pip install binance-algo
+pip install binance-sdk-algo
 ```
 
 ## Documentation
@@ -43,12 +42,12 @@ For detailed information, refer to the [Binance API Documentation](https://devel
 
 ### REST APIs
 
-All REST API endpoints are available through the [`rest_api`](./src/binance_algo/rest_api/rest_api.py) module. The REST API enables you to fetch market data, manage trades, and access account information. Note that some endpoints require authentication using your Binance API credentials.
+All REST API endpoints are available through the [`rest_api`](./src/binance_sdk_algo/rest_api/rest_api.py) module. The REST API enables you to fetch market data, manage trades, and access account information. Note that some endpoints require authentication using your Binance API credentials.
 
 ```python
 from binance_common.configuration import ConfigurationRestAPI
 from binance_common.constants import ALGO_REST_API_PROD_URL
-from binance_algo.algo import Algo
+from binance_sdk_algo.algo import Algo
 
 logging.basicConfig(level=logging.INFO)
 configuration = ConfigurationRestAPI(api_key="your-api-key", api_secret="your-api-secret", base_path=ALGO_REST_API_PROD_URL)
@@ -122,7 +121,7 @@ To enhance security, you can use certificate pinning with the `https_agent` opti
 
 The REST API provides detailed error types to help you handle issues effectively:
 
-- `ClientError`: Represents an error that occurred in the Connector client.
+- `ClientError`: Represents an error that occurred in the SDK client.
 - `RequiredError`: Thrown when a required parameter is missing or undefined.
 - `UnauthorizedError`: Indicates missing or invalid authentication credentials.
 - `ForbiddenError`: Access to the requested resource is forbidden.
@@ -151,10 +150,6 @@ The tests cover:
 * Error handling
 * Edge cases
 
-## Migration Guide
-
-If you are upgrading to the new modularized structure, refer to the [Migration Guide](./docs/migration_guide_algo_connector.md) for detailed steps.
-
 ## Contributing
 
 Contributions are welcome!

clients/algo/docs/migration_guide_algo_connector.md

@@ -9,8 +9,8 @@ from socket import create_connection
 from OpenSSL.crypto import dump_publickey, load_certificate, FILETYPE_ASN1
 
 from binance_common.configuration import ConfigurationRestAPI
-from binance_algo.algo import Algo
-from binance_algo.rest_api.models import QueryHistoricalAlgoOrdersSpotAlgoResponse
+from binance_sdk_algo.algo import Algo
+from binance_sdk_algo.rest_api.models import QueryHistoricalAlgoOrdersSpotAlgoResponse
 
 PINNED_PUBLIC_KEY = "YOUR-PINNED-PUBLIC-KEY"
 CA_CERT_PATH = "/path/to/certificate.pem"