Skip to content

Commit

Permalink
release 0.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
natecox committed Apr 9, 2015
1 parent 9b9e8ca commit d00ec9b
Show file tree
Hide file tree
Showing 13 changed files with 14 additions and 42 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
*.pyc
dist
shipstation.egg-info
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ This package provides the basic API bindings for interacting with
pyshipstation provides the class `ShipStation` to instantiate a new connection
to ShipStation.

import shipstation
from shipstation.api import *

api_key = '[your key]'
api_secret = '[your secret]'

ss = shipstation.ShipStation(key=api_key, secret=api_secret)
ss = ShipStation(key=api_key, secret=api_secret)

## ShipStationOrder
Orders can be provided using the `ShipStationOrder` class.
Expand All @@ -21,7 +21,7 @@ only `order_number` is actually required. ShipStation will generate a unique
key for you on submission.

id = '[a reference number]'
ss_order = shipstation.ShipStationOrder(order_number=id)
ss_order = ShipStationOrder(order_number=id)

### Setting The Order Status
Order status is set using the `set_status` method.
Expand All @@ -40,8 +40,8 @@ Customer username and email can be set with the `set_customer_deails` method.
Addresses are represented as a `ShipStationAddress` instance, and set
using the `set_shipping_address` or `set_billing_address` method.

shipping_address = shipstation.ShipStationAddress(...)
billing_address = shipstation.ShipStationAddress(...)
shipping_address = ShipStationAddress(...)
billing_address = ShipStationAddress(...)

ss_order.set_shipping_address(shipping_address)
ss_order.set_billing_address(billing_address)
Expand All @@ -50,30 +50,30 @@ using the `set_shipping_address` or `set_billing_address` method.
Package dimensions are represented as a `ShipStationContainer` instance, and
set using the `set_dimensions` method.

container = shipstation.ShipStationContainer(...)
container = ShipStationContainer(...)
ss_order.set_dimensions(container)

### Adding Line Items
Line items are represented as a `ShipStationItem` instance, and are added
individually using the `add_item` method.

item = shipstation.ShipStationItem(...)
item = ShipStationItem(...)
ss_order.add_item(item)

## ShipStationWeight
This corresponds to the Weight model in ShipStation, and accepts
`units` and `value`.

weight = shipstation.ShipStationWeight(units='ounces', value=12)
weight = ShipStationWeight(units='ounces', value=12)

## ShipStationContainer
This corresponds to the Dimensions model in ShipStation.

Weight is represented as a `ShipStationWeight` instance and added via the
`set_weight` method.

weight = shipstation.ShipStationWeight(...)
ss_container = shipstation.ShipStationContainer(
weight = ShipStationWeight(...)
ss_container = ShipStationContainer(
units='inches',
length=5,
width=5,
Expand All @@ -87,7 +87,7 @@ This corresponds to the Product model in ShipStation.
Weight is represented as a `ShipStationWeight` instance and added via the
`set_weight` method.

weight = shipstation.ShipStationWeight(...)
weight = ShipStationWeight(...)
ss_item = ShipStationItem(
sku='[your sku]',
name='[item name]',
Expand Down
Binary file removed dist/shipstation-0.0.2.tar.gz
Binary file not shown.
Binary file removed dist/shipstation-0.0.4.tar.gz
Binary file not shown.
Binary file removed dist/shipstation-0.0.5.tar.gz
Binary file not shown.
Binary file removed dist/shipstation-0.1.tar.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
include_package_data=True,
install_requires=['requests>=2.6.0'],
license='MIT',
py_modules=['shipstation'],
packages=['shipstation'],
url='https://github.com/natecox/pyshipstation',
)
18 changes: 0 additions & 18 deletions shipstation.egg-info/PKG-INFO

This file was deleted.

9 changes: 0 additions & 9 deletions shipstation.egg-info/SOURCES.txt

This file was deleted.

1 change: 0 additions & 1 deletion shipstation.egg-info/dependency_links.txt

This file was deleted.

1 change: 0 additions & 1 deletion shipstation.egg-info/requires.txt

This file was deleted.

1 change: 0 additions & 1 deletion shipstation.egg-info/top_level.txt

This file was deleted.

File renamed without changes.

0 comments on commit d00ec9b

Please sign in to comment.