https://github.com/vetronics/shopping_manager
A simple Python script to manage shopping items and values using a terminal-based interface.
https://github.com/vetronics/shopping_manager
apt debian debian-linux dnf fedora fedora-linux github-actions linux-shell macos procedure python python3 scrpit simple-project windows-11
Last synced: about 1 month ago
JSON representation
A simple Python script to manage shopping items and values using a terminal-based interface.
- Host: GitHub
- URL: https://github.com/vetronics/shopping_manager
- Owner: vetronics
- License: gpl-3.0
- Created: 2025-04-28T18:27:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-01T15:44:57.000Z (12 months ago)
- Last Synced: 2025-07-01T16:47:38.213Z (12 months ago)
- Topics: apt, debian, debian-linux, dnf, fedora, fedora-linux, github-actions, linux-shell, macos, procedure, python, python3, scrpit, simple-project, windows-11
- Language: Python
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🛒 Shopping Manager
**Shopping Manager** is a simple, cross-platform command-line tool written in Python that helps you manage shopping list items and their associated values. It features an ASCII-style interface and provides file-based storage for tracking and budgeting.
---
## ✨ Features
- ASCII Art interface using `pyfiglet`
- data visualization by 'pandas, matplotlib'
- Interactive command-line menu
- Add or remove shopping items
- Assign values to items (e.g., cost, quantity)
- Count total items and values
- Calculate the total sum of all values
- Saves data in plain `.csv` file
- No external database required
---
## 🧰 Requirements
- Python 3.x
👉 [Download Python](https://www.python.org/downloads/)
- `pyfiglet` module
- `pandas` module
- `matplotlib` module
- `pyautogui` module
---
## 💻 Installation Instructions
Follow the setup guide based on your operating system. Additionally, you can also use Docker to run the application.
---
### 🪟 Windows
1. **Install Python:**
- Download it from [python.org](https://www.python.org/downloads/)
- ✅ Check the box **“Add Python to PATH”** before clicking *Install Now*
2. **Open the terminal:**
- Press `Windows + S`, search for **Command Prompt**, **PowerShell**, or **Windows Terminal**
3. **Install `pyfiglet,pandas,matplotlib,pyautogui`:**
- Run the following command in your terminal:
```bash
pip install pyfiglet
pip install pandas
pip install matplotlib
pip install pyautogui
```
> If `pip` is not recognized, try this alternative command:
```bash
python -m pip install pyfiglet
python -m pip install pandas
python -m pip install matplotlib
python -m pip install pyautogui
```
4. **Run the script:**
- On **Windows**, you can **double-click** the `shopping_manager.py` file to run the script. The terminal window will appear, and you can interact with the application.
- If double-clicking doesn't work (i.e., the terminal closes immediately), open **Command Prompt** or **PowerShell**, navigate to the script's folder, and run:
```bash
python shopping_manager.py
```
---
### 🍎 macOS
1. **Install Python 3:**
- With [Homebrew](https://brew.sh/):
```bash
brew install python
```
- Or download it from [python.org](https://www.python.org/downloads/)
2. **Open Terminal:**
- Press `Command + Space`, type **Terminal**, then press Enter
3. **Install `pyfiglet,pandas,matplotlib,pyautogui`:**
- Run the following command in your terminal:
```bash
pip3 install pyfiglet
pip3 install pandas
pip3 install matplotlib
pip3 install pyautogui
```
> Or try:
```bash
python3 -m pip install pyfiglet
python3 -m pip install pandas
python3 -m pip install matplotlib
python3 -m pip install pyautogui
```
4. **Run the Script:**
- Open **Terminal**, navigate to the script's directory, and run:
```bash
python3 shopping_manager.py
```
---
### 🐧 Linux (Debian/Ubuntu)
1. **Install Python and pip:**
```bash
sudo apt update
sudo apt install python3 python3-pip
```
2. **Install `pyfiglet,pandas,matplotlib,pyautogui`:**
```bash
pip3 install pyfiglet
pip3 install pandas
pip3 install matplotlib
pip3 install pyautogui
```
3. **Run the Script:**
* Open **Terminal**, navigate to the script's directory, and run:
```bash
python3 shopping_manager.py
```
---
### 🐧 Linux (Fedora)
1. **Install Python and pip:**
```bash
sudo dnf install python3 python3-pip
```
2. **Install `pyfiglet,pandas,matplotlib,pyautogui`:**
```bash
pip3 install pyfiglet
pip3 install pandas
pip3 install matplotlib
pip3 install pyautogui
```
3. **Run the Script:**
* Open **Terminal**, navigate to the script's directory, and run:
```bash
python3 shopping_manager.py
```
---
This method does not require installing Python or dependencies on your local system, as everything will be handled by Docker.
---
## ✅ Setup Checklist
* [x] Install Python 3
* [x] Add Python to PATH (Windows)
* [x] Open Terminal or Command Prompt
* [x] Install `pyfiglet,pandas,matplotlib` with pip
---
## 🚀 How to Run
1. **Windows:**
* **Double-click** the `shopping_manager.py` file to run the script on Windows.
* If double-clicking doesn't work (i.e., the terminal closes immediately), open **Command Prompt** or **PowerShell**, navigate to the script's directory, and run:
```bash
python shopping_manager.py
```
2. **macOS and Linux (Debian/Ubuntu/Fedora):**
* Open **Terminal**, navigate to the script's directory, and run:
```bash
python3 shopping_manager.py
```
> Use `python` if `python3` doesn't work on your system.
---
## 📂 File Management
* The app saves shopping list items and their values in local `.csv` files.
* Ensure you have read/write permissions in the script directory.
---
## 🧾 Example Use Case
* Add items like `Milk`, `Eggs`, or `Bread`.
* Assign values like cost or quantity.
* Track total item count and sum of values.
* Remove or update items as needed.
---
## 🧰 Troubleshooting
* **Command not found**: Use `python3` or `pip3`.
* **Permission denied**: Run as administrator or use `sudo` on GNU/Linux machines.
* **pip not working**: Ensure Python is properly installed and in PATH.
---
## 📌 Notes
* Works on Windows, macOS, and Linux.
* Great for small shopping or budget tracking tasks.
* Easy to expand or customize.
---
## Development Environment: Visual Studio Community Edition
The scripts were written and tested using **Visual Studio Community Edition**, a free and feature-rich integrated development environment (IDE) from Microsoft. While Visual Studio is widely used for C# and .NET development, it also provides excellent support for Python development through the **Python Development workload**, which includes tools like:
- Python interpreter and virtual environment support
- Integrated terminal for running Python scripts
- Intelligent code completion (IntelliSense)
- Debugging tools
- Code navigation (go to definition, find references)
Visual Studio Community Edition allows Python developers to take advantage of a full-fledged IDE with powerful features like **Git integration**, **unit testing support**, and **built-in code analysis** tools. It provides a solid foundation for developing Python applications related to shopping and inventory management while maintaining a professional, user-friendly environment.
By using Visual Studio Community Edition, developers can streamline the process of coding, debugging, and testing Python scripts in a single platform, making it an ideal choice for both beginners and experienced developers.
## ⚠️ Compatibility Notes
If you're running the script on **macOS** or **Linux** (including **Fedora**, **Debian**, **Ubuntu**), you should **comment out** the following lines in the script:
```python
# os.system("cls") # Windows-specific clear screen
# os.system("title shopping manager") # Set terminal window title (Windows)
# os.system("color 05") # Change text color (Windows)
```
---