Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realharis/clf-shopify-integration-to-automate-stocks-updates
https://github.com/realharis/clf-shopify-integration-to-automate-stocks-updates
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/realharis/clf-shopify-integration-to-automate-stocks-updates
- Owner: RealHaris
- Created: 2024-12-07T15:37:53.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-10T09:30:05.000Z (29 days ago)
- Last Synced: 2024-12-10T10:30:54.868Z (29 days ago)
- Language: Python
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CLF Stock Update Automation
This project automates the synchronization of stock levels between CLF Distribution and Shopify platforms.
## Project Structure
```
UpdateStocks/
├── api/
│ ├── __init__.py
│ ├── clf_api.py # CLF Distribution API client
│ └── shopify_api.py # Shopify API client
├── utils/
│ ├── __init__.py
│ ├── logger_config.py # Logging configuration
│ ├── email_utils.py # Email sending utility using SendGrid
│ └── file_utils.py # File handling utilities
├── logs/ # Directory for log files
├── main.py # Main execution script
├── requirements.txt # Project dependencies
└── README.md # Project documentation
```
## Installation
To set up the project, clone the repository and install the required dependencies:
```bash
pip install -r requirements.txt
```
## Usage
1. Update the `credentials.json` file in the `data` directory with your CLF and Shopify credentials, as well as your SendGrid API key and email addresses.
2. Run the main script:
```bash
python main.py
```
## Email Notifications
The script sends email notifications using SendGrid in the following scenarios:
- When the stock update process completes successfully, including a summary of products updated and attached logs.
- When the token generation limit is exceeded, notifying that the script has stopped due to token generation limits.
## Logging
Logs are stored in the `logs` directory. The script generates logs for both successful operations and errors, which can be useful for debugging and monitoring.
## Features
- Automated stock level synchronization
- Comprehensive error handling and logging
- Rate limit handling for Shopify API
- Automatic token refresh for CLF API
- Detailed logging with separate files for different types of logs
## Setup
1. Install dependencies:
```bash
pip install -r requirements.txt
```
2. Configure API credentials:
- CLF Distribution credentials are currently in `clf_api.py`
- Shopify credentials are in `shopify_api.py`
Note: In production, these should be moved to environment variables.
3. Ensure the `logs` directory exists (will be created automatically if not present)
## Error Handling
The system includes comprehensive error handling for:
- Network errors
- API authentication failures
- Rate limiting
- Data parsing errors
- Product not found scenarios
## Future Improvements
1. Move credentials to environment variables
2. Add configuration file for API endpoints and other settings
3. Implement more robust rate limit handling
4. Add automated testing
5. Add monitoring and alerting capabilities
## License
This project is licensed under the MIT License.