Django wrapper around UPS Time In Transit JSON API
Project description
# Django UPS Time In Transit
django-ups-tnt is a wrapper around UPS's Time In Transit (TNT) API.
This wrapper is necessary because UPS's API is not public and requires Authentication details that cannot be shared
in javascript.
It provides some defaults to make the api easier to work with.
It also provides some form validation before hitting the UPS API and cache
# Installation
Requires djangorestframework>=3.3.0. Tested on Django 1.8 and 1.9.
1. Add `django-ups-tnt` to requirements.txt or pip install.
2. Add `url(r'^api/', include('ups_tnt.urls')),` to urls.py
3. Set required settings in settings.py
## Settings
### Required
UPS_USERNAME
UPS_PASSWORD
UPS_ACCESS_LICENSE_NUMBER
### Override defaults
UPS_DEFAULT_SHIP_FROM
UPS_DEFAULT_SHIP_TO
Default shipping addresses
Example syntax:
```
{
"Address": {
"CountryCode": "US",
}
}
```
UPS_BUFFER_DAYS - add buffer to when the item is shipped. Defaults to 0. Set to a int or callable.
UPS_DEFAULT_SHIPMENT_WEIGHT - Set shipment weight. Example
```
UPS_DEFAULT_SHIPMENT_WEIGHT = {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "Pounds"
},
"Weight": "90"
}
```
UPS_DEFAULT_INVOICE - Set value of shipment
```
UPS_DEFAULT_INVOICE = {
"CurrencyCode": "USD",
"MonetaryValue": "800"
}
```
UPS_TEST_LIVE - Set to `True` to make unit tests access actual API instead of mocks
UPS_CACHE_NAME - Set to the name of the cache to use. Defaults to `default`
django-ups-tnt is a wrapper around UPS's Time In Transit (TNT) API.
This wrapper is necessary because UPS's API is not public and requires Authentication details that cannot be shared
in javascript.
It provides some defaults to make the api easier to work with.
It also provides some form validation before hitting the UPS API and cache
# Installation
Requires djangorestframework>=3.3.0. Tested on Django 1.8 and 1.9.
1. Add `django-ups-tnt` to requirements.txt or pip install.
2. Add `url(r'^api/', include('ups_tnt.urls')),` to urls.py
3. Set required settings in settings.py
## Settings
### Required
UPS_USERNAME
UPS_PASSWORD
UPS_ACCESS_LICENSE_NUMBER
### Override defaults
UPS_DEFAULT_SHIP_FROM
UPS_DEFAULT_SHIP_TO
Default shipping addresses
Example syntax:
```
{
"Address": {
"CountryCode": "US",
}
}
```
UPS_BUFFER_DAYS - add buffer to when the item is shipped. Defaults to 0. Set to a int or callable.
UPS_DEFAULT_SHIPMENT_WEIGHT - Set shipment weight. Example
```
UPS_DEFAULT_SHIPMENT_WEIGHT = {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "Pounds"
},
"Weight": "90"
}
```
UPS_DEFAULT_INVOICE - Set value of shipment
```
UPS_DEFAULT_INVOICE = {
"CurrencyCode": "USD",
"MonetaryValue": "800"
}
```
UPS_TEST_LIVE - Set to `True` to make unit tests access actual API instead of mocks
UPS_CACHE_NAME - Set to the name of the cache to use. Defaults to `default`
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
django-ups-tnt-1.0.1.tar.gz
(4.9 kB
view hashes)
Built Distribution
Close
Hashes for django_ups_tnt-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ee4fa20b8d69aab3f0dc48ce8a3104c63f26391699b165de51550130a121fc3 |
|
MD5 | 12e467f9d376550eed3d6417613d2aed |
|
BLAKE2b-256 | ccb4e1b0fbc18d932662d940cd1f1cb3be11b0fa4a795c21c7a263aa30a0c15c |