https://github.com/yosephdev/love-sandwiches
A Python command-line application designed to automate data processes for a fictional sandwich company called Love Sandwiches.
https://github.com/yosephdev/love-sandwiches
Last synced: 2 months ago
JSON representation
A Python command-line application designed to automate data processes for a fictional sandwich company called Love Sandwiches.
- Host: GitHub
- URL: https://github.com/yosephdev/love-sandwiches
- Owner: yosephdev
- Created: 2024-01-31T14:50:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T18:46:11.000Z (over 2 years ago)
- Last Synced: 2025-05-24T07:39:22.356Z (about 1 year ago)
- Language: HTML
- Homepage: https://sandwich-automator-4e93d4a0a85f.herokuapp.com/
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sandwich Automator
Welcome to Sandwich Automator, a Python command-line application designed to automate data processes for a fictional sandwich company called Love Sandwiches.
## Overview
This application interacts with Google Sheets to collect and process sales data, calculate surplus, and make recommendations for future stock. It's deployed on Heroku, and you can access it [here](https://sandwich-automator-4e93d4a0a85f.herokuapp.com/).
## Getting Started
### Prerequisites
- Python 3
- Google Sheets API credentials (`creds.json`)
### Installation
1. Clone the repository: `git clone https://github.com/yosephdev/love-sandwiches`
2. Install dependencies: `pip install -r requirements.txt`
### Usage
Run the app using the following command:
```bash
python3 run.py
```
Follow the prompts to enter sales data and let the app automate the process.
## Key Features
- **Sales Data Entry**: Collects sales figures from the user for the last market.
- **Surplus Calculation**: Compares sales with stock to calculate surplus or waste.
- **Stock Recommendation**: Calculates the average stock for each item type and adds 10% for future markets.
## Code Structure
- **`run.py`**: Main Python file containing the project code.
- **`requirements.txt`**: File listing project dependencies.
## Deployed App
The app is deployed on Heroku. Access it [here](https://sandwich-automator-4e93d4a0a85f.herokuapp.com/).