Inventory Report

The project consists of implementing an object-oriented report generator in Python that reads inventory data from CSV, JSON or XML files and generates a simple or complete report.

Table of Contents

1. About The Project
2. Usage
3. Getting Started
   • Prerequisites
   • Installation
4. Contact
5. Acknowledgments

About The Project

Usage

The project consists of implementing an object-oriented report generator in Python that reads inventory data from CSV, JSON or XML files and generates a simple or complete report. Skills covered include object-oriented concepts, design patterns and reading/writing files in different formats. The objective is to apply knowledge in programming and data structuring to generate efficient and accurate reports from different sources.

(back to top)

Getting Started

Prerequisites

To get a local copy up and running check below and follow these simple steps if needed.

Installation

• Install python

1. Fork the repo
2. Clone the repo

   git clone git@github.com:< USERNAME >/Project_TFC

3. Start virtual enviroment and install dependecies

   python3 -m venv .venv
   source .venv/bin/activate
   python3 -m pip install -r dev-requirements.txt

OR

• install docker

1. Fork the repo
2. Clone the repo

   git clone git@github.com:< USERNAME >/Project_TFC

3. Start docker development environment

• In the root folder:

  docker-compose run --rm inventory pytest

(back to top)

Contact

Renato Dourado - Linkedin - renatocvdourado@hotmail.com

Project Link: https://github.com/RenatoDourad0/Project_invertory_report

(back to top)

Acknowledgments

Contributors besides the team were responsible for evaluation files that have been removed after approval.

(back to top)