From 6a290a1b3e9a8a78a06477f448f825e498b433d5 Mon Sep 17 00:00:00 2001 From: Spectre Date: Fri, 10 Oct 2025 10:02:54 +0200 Subject: [PATCH] Complete readme.md file --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/README.md b/README.md index e69de29..1e5294a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,60 @@ +# OVH Invoice Fetcher + +Automated script for retrieving, indexing, and archiving invoices from the OVH API. +Handles logging, database persistence, and email notifications for both normal operations and errors. + +--- + +## Overview + +This application connects to the OVH API to: +1. Fetch all invoice IDs. +2. Compare them with previously downloaded or recorded invoices. +3. Download missing invoice PDFs. +4. Store metadata in a SQLite database. +5. Send an email report with the list of newly downloaded invoices. + +It automatically categorizes invoices by year and stores them in year-specific directories. + +--- + +## Requirements + +- Python 3.10+ +- Valid OVH API credentials +- SMTP server access for email notifications + +--- + +## Installation +You would need to create a .env file that contain: +```env +APP_KEY +APP_SECRET +CONSUMER_KEY +PATH_OVH +DB_PATH +EMAIL +EMAIL_PASSWORD +SMTP_MAIL_ADDRESS +SMTP_PORT +EMAIL_TO +YEAR +``` + +```bash +git clone git@github.com:Fare-spec/get_ovh_bills.git +cd get_ovh_bills +pip install -r requirements.txt +``` +With uv: + + +```bash + +git clone git@github.com:Fare-spec/get_ovh_bills.git +cd get_ovh_bills +uv venv +uv run main.py + +```