README.md

📦 Inventory Manager – Week 3

A modular Python inventory management system with Pydantic validation, error handling, logging, and automated testing using pytest.

---

📖 Overview

This project demonstrates:

• Modular Python package design
• Data validation with Pydantic
• Error handling and logging
• Test-driven development with pytest
• Code coverage analysis

📄 Read more: Project Overview

---

🗂 Code Structure

The project is organized for clarity and maintainability, following best practices for Python packaging.

📄 Full details: Code Structure

---

⚙️ Setup Instructions

To install dependencies and prepare the development environment:

📄 Setup guide: Installation & Setup

---

🧪 Running Tests

This project uses pytest for testing and pytest-cov for coverage.

📄 Testing guide: Testing Instructions

---

🚀 Quick Start

1️⃣ Clone repository

git clone https://github.com/your-username/inventory-manager.git
cd inventory-manager

2️⃣ Create virtual environment

python -m venv venv
source venv/bin/activate   # Linux/Mac
venv\Scripts\activate      # Windows

3️⃣ Install dependencies

pip install -r requirements.txt

4️⃣ Run main program

python -m Week3.main

5️⃣ Run all tests

pytest