A Python package for interacting with Amazon Marketplace Web Services (MWS).
This project is a fork and continuation of czpython/python-amazon-mws with Python 3 support, more MWS API coverage, and new features.
Join us on Slack!
| Branch | Coverage | Testing | Version |
|---|---|---|---|
master |
 |
N/A |  |
develop |
 |
 |
1.0.0-dev (GitHub install required) |
Two versions are currently available:
- Installing
mwsfrom PyPI, you will have version 0.8.x, which is built from ourmasterbranch.- This is a close match to the original package by czpython, with some small tweaks to add critical functionality.
- Supports Python 2.7 and 3.4+.
- The updated 1.0.0-dev version must be installed from this repo's
developbranch.- This includes additional API coverage that may be missing in 0.8.x, as well as other new features.
- Some methods have new or updated arguments compared to 0.8.x, and much of the original monolithic
mwsmodule has been broken down into separate components (such as themws.apiscollection of modules). - Supports Python 3.5+.
Warning: If you are using version 0.8.x in a production system, note that our eventual 1.0 release will be backwards-incompatible, and may break programs that depend on the 0.8.x version. We advise users pin their Pip-installed version in requirements as
mws~=0.8.9.
Install the mws package using Pip:
pip install mwsAlternatively, you can install direct from this repo's master branch, like so:
pip install git+https://github.com/python-amazon-mws/python-amazon-mws.git@master#egg=mwsOur develop version can be installed directly from the repo using:
pip install git+https://github.com/python-amazon-mws/python-amazon-mws.git@develop#egg=mwsNote that code may be updated at any time as development continues, so please use at your own risk.
Export your API credentials as environment variables in your shell.
export MWS_ACCOUNT_ID=...
export MWS_ACCESS_KEY=...
export MWS_SECRET_KEY=...Now you can experiment with the API from within an interactive Python shell e.g.
>>> import mws, os
>>> orders_api = mws.Orders(
... access_key=os.environ['MWS_ACCESS_KEY'],
... secret_key=os.environ['MWS_SECRET_KEY'],
... account_id=os.environ['MWS_ACCOUNT_ID'],
... region='UK', # defaults to 'US'
... )
>>> service_status = orders_api.get_service_status()
>>> service_status
<mws.mws.DictWrapper object at 0x1063a2160>
>>> service_status.original
'<?xml version="1.0"?>\n<GetServiceStatusResponse xmlns="https://mws.amazonservices.com/Orders/2013-09-01">\n <GetServiceStatusResult>\n <Status>GREEN</Status>\n <Timestamp>2017-06-14T16:39:12.765Z</Timestamp>\n </GetServiceStatusResult>\n <ResponseMetadata>\n <RequestId>affdec68-05d2-4bc5-a8a4-bb40f307dd6b</RequestId>\n </ResponseMetadata>\n</
GetServiceStatusResponse>\n'
>>> service_status.parsed
{'value': '\n ', 'Status': {'value': 'GREEN'}, 'Timestamp': {'value': '2017-06-14T16:39:12.765Z'}}
>>> service_status.response
<Response [200]>All dependencies for developing on mws are in requirements-dev.txt.
Tests are run with pytest. We test against Python 3.5+ using GitHub Actions, on latest Ubuntu, Mac, and Windows OSes.
Docs are built using Sphinx. Change into the docs/ directory and install any dependencies from the requirements.txt there.
To build HTML documentation, run:
make htmlThe output HTML documentation will be in docs/build/.
To run a live reloading server serving the HTML documentation (on port 8000 by default):
make livehtmlPlease make pull requests to develop. Code coverage isn't necessary but encouraged where possible (especially for anything which might behave differently between Python 2/3).
For support using the package, please join our Slack and post in the #help channel.
For support using MWS itself, we advise using the MWS documentation