Skip to main content

​
System Requirements

Before installing the system, ensure you have the following:

Python 3

Python 3.7 or higher is required

pip

Python package manager (included with Python)

​
Check Your Python Version

Verify that Python 3 is installed on your system: 
python --version
# or
python3 --version
You should see output like Python 3.x.x. If not, download Python before continuing.

​
Installation Steps

1

Clone or Download the Repository

Get the source code onto your local machine:
git clone <repository-url>
cd <repository-name>
Or download and extract the ZIP file from your repository.
2

Install Dependencies

Install all required Python packages using the requirements.txt file:
pip install -r requirements.txt
This installs:
  • pandas - Data analysis library
  • openpyxl - Excel file support
  • matplotlib - Chart generation
  • numpy - Numerical operations
  • python-dotenv - Environment variable management
If you encounter permission errors, try using pip install --user -r requirements.txt
3

Understand the Directory Structure

The system expects the following structure:
.
├── src/
│   ├── main.py              # Entry point
│   ├── loader.py            # Data loading
│   ├── analisis.py          # ABC classification
│   ├── decisiones.py        # Risk evaluation
│   ├── reportes.py          # Excel report generation
│   ├── reportes_graficos.py # Chart generation
│   ├── emailer.py           # Email automation
│   └── config.py            # Configuration
├── data/                    # Input folder (create this)
│   └── inventario.xlsx      # Your inventory file
├── output/                  # Auto-created on first run
│   ├── reporte_inventario.xlsx
│   └── graficos/
└── requirements.txt
The output/ folder and output/graficos/ subfolder are created automatically when you run the system. You don’t need to create them manually.
4

Create the Data Folder

Create a data/ folder in the project root to store your inventory files:
mkdir data
This is where you’ll place your inventario.xlsx file.
5

Configure Email (Optional)

If you want automatic email delivery, create a .env file in the project root:
touch .env
Add your email credentials:
[email protected]
EMAIL_PASSWORD=your-app-password
[email protected]
For Gmail, you must use an App Password, not your regular password. The system uses Gmail’s SMTP server (smtp.gmail.com:465) by default.
Email is optional. If you skip this step, the system will generate reports locally and skip email delivery with a warning message.

​
Verify Installation

Confirm that all dependencies are installed correctly: 
python -c "import pandas, openpyxl, matplotlib, numpy; print('All dependencies installed successfully')"
If you see the success message, you’re ready to proceed!

​
What’s Next?

Your system is now installed and ready to use. The next step is to prepare your inventory data and run your first analysis.

Quick Start Guide

Learn how to create your inventory file and run your first analysis

Build docs developers (and LLMs) love

Get started for freeTalk to us