Metadata-Version: 2.4
Name: yqn-client
Version: 1.0.0
Summary: YQN API Client - A Python client for YQN logistics
Author-email: YQN Client Contributors <1361720765@qq.com>
License: MIT
Project-URL: Homepage, https://github.com/cpcc/yqn-client-python
Project-URL: Documentation, https://github.com/cpcc/yqn-client-python#readme
Project-URL: Repository, https://github.com/cpcc/yqn-client-python.git
Project-URL: Issues, https://github.com/cpcc/yqn-client-python/issues
Keywords: yqn,api,client,logistics,ecommerce,warehouse
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
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
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: typing-extensions>=4.0.0; python_version < "3.10"
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: flake8>=5.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: pre-commit>=2.20.0; extra == "dev"
Dynamic: license-file

# YQN Client Python

A comprehensive Python client for YQN logistics, built with requests and Pydantic for type safety and ease of use.

## Features

- 🚀 Full async and sync support
- 📝 Type-safe models using Pydantic
- 🔧 Easy configuration
- 📚 Comprehensive API coverage
- 🧪 Full test coverage
- 📖 Detailed documentation

## Installation

```bash
pip install yqn-client
```

## Quick Start

```python
from yqn_client import YQNClient

# Initialize client
client = YQNClient(
    api_key="your-api-key",
    base_url="https://api.yqn.com"
)

# Get product list
products = client.products.list()
print(products)

# Create a product
product = client.products.create({
    "name": "Test Product",
    "sku": "TEST-001",
    "price": 99.99
})
```

## API Modules

The client is organized into the following modules:

- **Products** - Product management, SKU operations
- **Warehouse Plans** - Inbound plan management
- **Inventory** - Stock and inventory operations
- **Orders** - Sales order management
- **Returns** - Return order operations
- **Transfers** - Stock transfers
- **Appointments** - Appointment scheduling
- **Base Data** - Basic data queries
- **Auth** - Third-party authorization
- **Shipping** - Shipping fee calculations
- **Cost** - Cost and fee operations

## Documentation

Full documentation is available at [GitHub Repository](https://github.com/cpcc/yqn-client-python#readme).

## Development

```bash
# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black src tests

# Type checking
mypy src
```

## License

This project is licensed under the MIT License - see the LICENSE file for details.
