Metadata-Version: 2.1
Name: sbux
Version: 0.3.0
Summary: An unofficial Starbucks Singapore (SG) software development kit (SDK).
Home-page: https://github.com/ngshiheng/sbux
License: MIT
Author: Jerry Ng
Author-email: ngshiheng@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: dataclasses-json (>=0.5.7,<0.6.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Project-URL: Repository, https://github.com/ngshiheng/sbux
Description-Content-Type: text/markdown

# sbux

[![CI](https://github.com/ngshiheng/sbux/actions/workflows/ci.yml/badge.svg)](https://github.com/ngshiheng/sbux/actions/workflows/ci.yml)
[![Semantic Release](https://github.com/ngshiheng/sbux/actions/workflows/release.yml/badge.svg)](https://github.com/ngshiheng/sbux/actions/workflows/release.yml)

`sbux` is an unofficial Starbucks Singapore (SG) software development kit (SDK).

`sbux` is named after the ticker symbol of Starbucks Corporation (SBUX) on the NASDAQ.

## Installing

Install and update using `pip`;

```sh
pip install sbux
```

## A Simple Example

```python
from sbux import Starbucks


starbucks = Starbucks
starbucks.get_stores()
starbucks.get_menu_items(branch_code="13377")
```

## Contributing

For guidance on setting up a development environment and how to make a contribution, see the [contributing guidelines](./docs/CONTRIBUTING.md).

