https://github.com/alexdlaird/amazon-orders

A CLI and library for interacting with Amazon order history
https://github.com/alexdlaird/amazon-orders

amazon cli library python

Last synced: 2 months ago
JSON representation

A CLI and library for interacting with Amazon order history

• Host: GitHub
• URL: https://github.com/alexdlaird/amazon-orders
• Owner: alexdlaird
• License: mit
• Created: 2024-01-05T16:21:11.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-07-16T19:12:17.000Z (6 months ago)
• Last Synced: 2024-10-07T08:12:05.466Z (3 months ago)
• Topics: amazon, cli, library, python
• Language: Python
• Homepage: https://amazon-orders.readthedocs.io/en/latest
• Size: 1010 KB
• Stars: 15
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


[![Version](https://img.shields.io/pypi/v/amazon-orders)](https://pypi.org/project/amazon-orders)

[![Python Versions](https://img.shields.io/pypi/pyversions/amazon-orders.svg)](https://pypi.org/project/amazon-orders)

[![Coverage](https://img.shields.io/codecov/c/github/alexdlaird/amazon-orders)](https://codecov.io/gh/alexdlaird/amazon-orders)

[![Build](https://img.shields.io/github/actions/workflow/status/alexdlaird/amazon-orders/build.yml)](https://github.com/alexdlaird/amazon-orders/actions/workflows/build.yml)

[![Docs](https://img.shields.io/readthedocs/amazon-orders)](https://amazon-orders.readthedocs.io)

[![GitHub License](https://img.shields.io/github/license/alexdlaird/amazon-orders)](https://github.com/alexdlaird/amazon-orders/blob/main/LICENSE)

`amazon-orders` is an unofficial library that provides a command line interface alongside a programmatic API that can

be used to interact with Amazon.com's consumer-facing website.

This works by parsing website data from Amazon.com. A periodic build validates functionality to ensure its

stability, but as Amazon provides no official API to use, this package may break at any time. This

package only officially supports the English version of the website.

## Installation

`amazon-orders` is available on [PyPI](https://pypi.org/project/amazon-orders/) and can be installed using `pip`:

```sh

pip install amazon-orders

```

That's it! `amazon-orders` is now available as a Python package is available from the command line.

## Basic Usage

Execute `amazon-orders` from the command line with:

```sh

amazon-orders --username  --password  history

```

Or use `amazon-orders` programmatically:

```python

from amazonorders.session import AmazonSession

from amazonorders.orders import AmazonOrders

amazon_session = AmazonSession("",

                               "")

amazon_session.login()

amazon_orders = AmazonOrders(amazon_session)

orders = amazon_orders.get_order_history(year=2023)

for order in orders:

    print(f"{order.order_number} - {order.grand_total}")

```

## Documentation

For more advanced usage, `amazon-orders`'s official documentation is available

at [http://amazon-orders.readthedocs.io](http://amazon-orders.readthedocs.io).

## Contributing

If you would like to get involved, be sure to review

the [Contribution Guide](https://github.com/alexdlaird/amazon-orders/blob/main/CONTRIBUTING.rst).

Want to contribute financially? If you've found `amazon-orders`

useful, [sponsorship](https://github.com/sponsors/alexdlaird) would

also be greatly appreciated!