Metadata-Version: 2.1
Name: junglescout-client
Version: 0.2.2
Summary: Jungle Scout API Client
Home-page: https://github.com/Junglescout/jungle-scout-python-client
License: MIT
Author: Jungle Scout
Author-email: support@junglescout.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
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pydantic (>=2.6.3,<3.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Project-URL: Documentation, https://python-client.junglescout.com
Project-URL: Homepage, https://developer.junglescout.com/api
Project-URL: Issues, https://github.com/Junglescout/junglescout-python-client/issues
Project-URL: Postman Collection, https://postman.junglescout.com/
Project-URL: Repository, https://github.com/Junglescout/junglescout-python-client.git
Description-Content-Type: text/markdown

# Jungle Scout Python Client

The official Jungle Scout API Python Client. Documentation for this client is available
on [Read the Docs](https://jungle-scout-junglescout-python-client.readthedocs-hosted.com).

See the [Jungle Scout API Documentation](https://developer.junglescout.com) and the
[Jungle Scout Postman Collection](https://postman.junglescout.com) for more information about
the Jungle Scout API.

## Installation

```bash
pip install junglescout-client
```

## Usage

This client is designed to be simple and easy to use. Here's a quick example of how to use the client to get
keywords by ASIN:

```python
from junglescout.client import Client
from junglescout.models.parameters import Marketplace, ApiType, FilterOptions, Sort

API_KEY_NAME = "api_key_name"
API_KEY = "api_key"

client = Client(
    api_key_name=API_KEY_NAME,
    api_key=API_KEY,
    marketplace=Marketplace.US,
    api_type=ApiType.JS
)

filter_options = FilterOptions(min_monthly_search_volume_exact=150)

keywords = client.keywords_by_asin(
    asin='B005IHSKYS',
    filter_options=filter_options,
    sort_option=Sort.MONTHLY_SEARCH_VOLUME_EXACT_MATCH
)
```

All the API methods are available from the `Client` class. See
the [documentation](https://jungle-scout-junglescout-python-client.readthedocs-hosted.com) for complete API
reference information.

### Pydantic Models

This project defines API model objects using
[Pydantic](https://docs.pydantic.dev/latest). Autocomplete for model parameters
during instantiation should work by default in most modern IDEs. For Jetbrains
IDEs, the [Pydantic](https://plugins.jetbrains.com/plugin/12861-pydantic) plugin
is required for autocomplete. See the following links for more information:

- [pydantic/pull/2721](https://github.com/pydantic/pydantic/pull/2721)
- [pydantic/issues/650](https://github.com/pydantic/pydantic/issues/650)

## Contributing

Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md) for more information.

