Skip to content

Commit caffa56

Browse files
Initial commit: Inventory Management System with README, LICENSE, tests, and sample data
0 parents  commit caffa56

File tree

6 files changed

+542
-0
lines changed

6 files changed

+542
-0
lines changed

.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Python cache & environment
2+
__pycache__/
3+
*.pyc
4+
*.pyo
5+
*.pyd
6+
*.env
7+
*.venv
8+
env/
9+
venv/
10+
11+
# OS generated files
12+
.DS_Store
13+
Thumbs.db
14+
15+
# Inventory data files (keep local, don't push)
16+
inventory.txt
17+
*_backup.txt
18+
19+
# Test run outputs (optional)
20+
test/*.txt
21+
test/__pycache__/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Rumaisa Islam
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
Perfect! Let’s make a **professional README.md** for your Inventory Management project with all the elements you asked for: banner, badges, username, and clear instructions.
2+
3+
Here’s a polished version you can directly use:
4+
5+
```markdown
6+
<p align="center">
7+
<img src="banner.png" alt="Inventory Management Banner" width="800"/>
8+
</p>
9+
10+
# Inventory Management System
11+
12+
**Author:** [Rumaisas-islam](https://github.com/Rumaisas-islam)
13+
**Language:** Python 🐍
14+
15+
![Python Version](https://img.shields.io/badge/python-3.11-blue?logo=python)
16+
![License](https://img.shields.io/badge/license-MIT-green)
17+
![VIP Level](https://img.shields.io/badge/VIP-Level%20Ultimate-orange)
18+
19+
---
20+
21+
## Overview
22+
This is a **simple console-based Inventory Management System** in Python that allows you to:
23+
24+
- Add inventory items
25+
- Search inventory by `Item_ID`, `Item_Name`, `Category`, or `Supplier_Name`
26+
- Delete inventory items
27+
- Update inventory items
28+
- View all inventory IDs, names, or full inventory records
29+
30+
The program maintains an **inventory text file (`inventory.txt`)** and creates **backups** before deletion or update.
31+
32+
---
33+
34+
## Features
35+
1. **ID Generator:** Automatically generates unique `Item_ID`.
36+
2. **Validation:** Input checks for proper data types.
37+
3. **Backup:** Automatic backup created before deletion or update.
38+
4. **Search:** Search inventory by multiple fields.
39+
5. **View Options:** View only IDs, names, or all inventory details.
40+
41+
---
42+
43+
## File Structure
44+
```
45+
46+
Inventory-Management/
47+
48+
├── inventory.txt # Main inventory data file
49+
├── sample.txt # Sample data for testing
50+
├── test/ # Folder for automated tests
51+
├── banner.png # Project banner
52+
├── LICENSE # MIT License
53+
├── README.md # Project documentation
54+
└── .gitignore # Git ignore file
55+
56+
```
57+
58+
---
59+
60+
## How to Run
61+
1. Clone the repository:
62+
```bash
63+
git clone https://github.com/Rumaisas-islam/Python-Inventory-Management-System.git
64+
```
65+
66+
2. Navigate to the project folder:
67+
68+
```bash
69+
cd Inventory-Management
70+
```
71+
72+
3. Run the program:
73+
74+
```bash
75+
python inventory_management.py
76+
```
77+
78+
4. Follow the on-screen menu to manage inventory.
79+
80+
---
81+
82+
## Testing
83+
84+
Automated tests are included in the `test/` folder. Run tests using:
85+
86+
```bash
87+
python -m unittest discover test
88+
```
89+
90+
---
91+
92+
## License
93+
94+
This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
95+
96+
---
97+
98+
## Author
99+
100+
[Rumaisas-islam](https://github.com/Rumaisas-islam)
101+
Python Developer | Console App Enthusiast

0 commit comments

Comments
 (0)