Metadata-Version: 2.1
Name: shopify_custom_api
Version: 0.1.3
Summary: A simple library that helps call Shopify's API
Home-page: https://github.com/bachnguyen2001/shopify_custom_api.git
Author: Nguyen Ngoc Bach
Author-email: bachnguyenfptu@gmail.com
License: MIT
Keywords: shopify rest api
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: requests

# Shopify Custom API Library

A custom Shopify API library that make shopify api call more easy.

## Table of Contents

- [Shopify Custom API Library](#shopify-custom-api-library)
  - [Table of Contents](#table-of-contents)
  - [Features](#features)
  - [Installation](#installation)
  - [Getting started](#getting-started)
    - [setup](#setup)
    - [option](#option)
      - [get](#get)
      - [post](#post)
      - [put](#put)
      - [delete](#delete)
## Features

- Easy authentication with Shopify.
- Simplified methods for common API operations.
- Support for additional Shopify API endpoints not covered by the official library.

## Installation

To install the package, you can use `pip`:

```sh
pip install -U shopify_custom_api
```
## Getting started
- Generate access token for your store by following instruction
  (https://help.plytix.com/en/getting-api-credentials-from-your-shopify-store)

- checkout shopify api document
  (https://shopify.dev/docs/api/admin-rest)

### setup
```py
from cshopify import API

shop = API(store_url='STORE_NAME', access_token='shpat_xxxxxxxxxxxxxxxxxxxxxxx', api_version='2024-01')
```

### option 
|parameter|description|
|----|------------------|
|data| JSON format data |
|endpoint| Resource type that need to be processed |
|params| Additional parameters for query |
#### get
```py
.get(endpoint, params)
```
#### post
```py
.post(endpoint, data)
```
#### put
```py
.put(endpoint, data)
```
#### delete
```py
.delete(endpoint)
```


