Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imsalmanmalik/shopify-google-sheet-slack-automation
This project automates the fetching of Shopify data, appending it to a Google Sheet, and sending notifications to a Slack channel.
https://github.com/imsalmanmalik/shopify-google-sheet-slack-automation
google-cloud google-sheets-api python shopify slack
Last synced: 29 days ago
JSON representation
This project automates the fetching of Shopify data, appending it to a Google Sheet, and sending notifications to a Slack channel.
- Host: GitHub
- URL: https://github.com/imsalmanmalik/shopify-google-sheet-slack-automation
- Owner: imsalmanmalik
- Created: 2024-05-22T18:37:55.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-31T21:48:11.000Z (7 months ago)
- Last Synced: 2024-10-25T02:38:46.104Z (3 months ago)
- Topics: google-cloud, google-sheets-api, python, shopify, slack
- Language: Python
- Homepage:
- Size: 18.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shopify Google Sheet Slack Automation
This project automates the fetching of Shopify data, appending it to a Google Sheet, and sending notifications to a Slack channel.
Docker image built runs every midnight, to run it manually refer to [Scheduled Task](#scheduled-task)
## Features
- Fetch orders data from Shopify API.
- Calculate differences between current and previous values.
- Append data to a Google Sheet and format headers.
- Send notifications to a Slack channel.
## Setup
### Prerequisites
- Python 3.8 or higher
- Docker
- A Google Cloud project with Google Sheets API enabled.
- A Slack workspace and API token.
### Environment Variables
You need to set the following environment variables. These will be configured as secrets in GitHub Actions:
- `SHOP_NAME`: Your Shopify store name.
- `API_VERSION`: The version of the Shopify API you are using.
- `ADMIN_API_ACCESS_TOKEN`: Your Shopify Admin API access token.
- `GOOGLE_SHEET_ID`: The ID of the Google Sheet you want to update.
- `SLACK_API_TOKEN`: Your Slack API token.
- `SLACK_CHANNEL_ID`: The Slack channel ID where notifications will be sent.
- `GOOGLE_PROJECT_ID`: Your Google Cloud project ID.
- `GOOGLE_PRIVATE_KEY_ID`: Your Google private key ID.
- `GOOGLE_PRIVATE_KEY`: Your Google private key (ensure newline characters are replaced by `\n`).
- `GOOGLE_CLIENT_EMAIL`: Your Google client email.
- `GOOGLE_CLIENT_ID`: Your Google client ID.
- `GOOGLE_AUTH_URI`: The Google auth URI.
- `GOOGLE_TOKEN_URI`: The Google token URI.
- `GOOGLE_AUTH_PROVIDER_X509_CERT_URL`: The Google auth provider x509 cert URL.
- `GOOGLE_CLIENT_X509_CERT_URL`: The Google client x509 cert URL.
- `GITHUB_TOKEN`: Automatically provided by GitHub Actions.
### Local Development
1. **Install Dependencies**
```sh
pip3 install -r requirements.txt
```
2. **Run the Script**
```sh
python3 fetch_shopify_data.py
```
### Using `requirements.in`
If you want to use `requirements.in` to manage your dependencies, you can generate a `requirements.txt` file using `pip-compile`. This is useful for repeatable builds and to have more control over the updates.
1. **Install `pip-tools`**
```sh
pip install pip-tools
```
2. **Generate `requirements.txt` from `requirements.in`**
```sh
pip-compile --output-file=requirements.txt requirements.in
```
### Docker
1. **Build the Docker Image**
```sh
docker build -t shopify-automation:latest .
```
2. **Run the Docker Container**
You can either specify environment variables separately or in a env file itself.
```sh
docker run --rm \
-e SHOP_NAME=your_shop_name \
-e API_VERSION=your_api_version \
-e ADMIN_API_ACCESS_TOKEN=your_admin_api_access_token \
-e GOOGLE_SHEET_ID=your_google_sheet_id \
-e SLACK_API_TOKEN=your_slack_api_token \
-e SLACK_CHANNEL_ID=your_slack_channel_id \
-e GOOGLE_PROJECT_ID=your_google_project_id \
-e GOOGLE_PRIVATE_KEY_ID=your_google_private_key_id \
-e GOOGLE_PRIVATE_KEY="your_google_private_key" \
-e GOOGLE_CLIENT_EMAIL=your_google_client_email \
-e GOOGLE_CLIENT_ID=your_google_client_id \
-e GOOGLE_AUTH_URI=your_google_auth_uri \
-e GOOGLE_TOKEN_URI=your_google_token_uri \
-e GOOGLE_AUTH_PROVIDER_X509_CERT_URL=your_google_auth_provider_x509_cert_url \
-e GOOGLE_CLIENT_X509_CERT_URL=your_google_client_x509_cert_url \
shopify-automation:latest
```
or
```sh
docker run --env-file file.env shopify-fetch-script
```
### GitHub Actions
This project includes two GitHub Actions workflows:
1. **CI/CD Pipeline**: Builds the Docker image and pushes the Docker image to GitHub Container Registry (GHCR).
2. **Scheduled Task**: Runs the Docker image every midnight to update the Google Sheet and send a Slack notification.
## CI/CD Pipeline
```mermaid
graph TD
A[Push to GitHub] --> B[GitHub Actions]
B --> C[Build Docker Image]
C --> D[Push Docker Image to GHCR]
```
## Scheduled Task
```mermaid
graph TD
A[Cron Job] --> B[GitHub Actions]
B --> C[Pull Docker Image]
C --> D[Run Docker Container]
D --> E[Update Google Sheet]
E --> F[Send Slack Notification]
```
You can also run the the `Scheduled Task` pipeline manually by going into the Action (depending on the access).
Slack channel used for internal testing: `#mm-candidate-salman-malik`