YQN API Client - A Python client for YQN logistics
Project description
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
pip install yqn-client
Quick Start
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.
Development
# 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yqn_client-1.0.0.tar.gz.
File metadata
- Download URL: yqn_client-1.0.0.tar.gz
- Upload date:
- Size: 17.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
38f97cfd92cd4b253616351315723fca372803a90c617da0296adbe192154219
|
|
| MD5 |
95d2fad4df1ee76b4ff29a43d624a5d1
|
|
| BLAKE2b-256 |
1e0db7b3a74a2751c2739b36831f085e919259facd027ceb2f31ea60e749bc00
|
File details
Details for the file yqn_client-1.0.0-py3-none-any.whl.
File metadata
- Download URL: yqn_client-1.0.0-py3-none-any.whl
- Upload date:
- Size: 21.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b76417bcdab7175336480fb08faf8cbd55b801cf80784058013946be268277ac
|
|
| MD5 |
2139a8628dfc7942f38324173ab4454f
|
|
| BLAKE2b-256 |
0a5ff6c3d117ea53e24842d59115548aa11d0afaa798f829d7115278e7a2abe6
|