Skip to content

CodesbyNeo/Chicken-Brothers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍗 Chicken Brothers — Business Management System

CI Python SQLite License

A real-world Python + SQLite business management system built for Chicken Brothers — a catering business specializing in chicken portions, wors rolls, and chips. Tracks inventory, catering events, sales, expenses, capital contributions, and profit reports.


🚀 Features

  • Event/Catering Management — create and track catering jobs
  • Inventory Tracking — whole chickens, wors, spices, charcoal, chips, rolls
  • Low Stock Alerts — notified on startup when stock is running low
  • Sales Recording — ¼ chicken, ½ chicken, wors rolls, chips, combos
  • Capital Contributions — log how much each of the 3 owners contributed
  • Expense Tracking — per event or general business expenses
  • Profit Reports — income vs expenses per event + overall summary
  • SQLite Database — no server needed, data persists locally
  • 7 Unit Tests — pytest test suite

⚡ Quick Start

git clone https://github.com/CodesbyNeo/chicken-brothers.git
cd chicken-brothers
python app/main.py

No installation needed — uses Python standard library only!


📋 How to Use

Running the app

python app/main.py

Typical event workflow:

  1. Create Event → enter name, date, location
  2. Log Contributions → each owner enters how much capital they put in
  3. Use Stock → record what ingredients were used
  4. Record Sales → enter quantities of each item sold
  5. View Profit Report → see income, expenses, and net profit

🗃️ Database Schema

Table Purpose
inventory Stock items with quantities and low-stock thresholds
events Catering jobs with date, location, status
contributions Capital contributed per owner per event
sales Items sold per event with quantities and prices
expenses Costs recorded per event or general
stock_usage Ingredients used per event

🧪 Running Tests

python -m pytest tests/ -v

📊 Sample Report Output

📊 PROFIT REPORT — Community Braai June 2024
═════════════════════════════════════════════
  💵 Total Sales Income    :    R2,450.00
  💸 Total Expenses        :    R1,100.00
─────────────────────────────────────────────
  📈 Gross Profit          :    R1,350.00
  💰 Owner Contributions   :      R900.00
─────────────────────────────────────────────
  🏦 Net to Business Acct  :      R450.00 ✅
═════════════════════════════════════════════

📄 License

MIT

About

Real-world Python + SQLite business management system for a catering business. CLI version — see also the Desktop App: github.com/CodesbyNeo/Chicken-Brothers-App

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages