Skip to content

Huluti/lavender-report

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LavenderReport

LavenderReport is an open-source command-line tool for categorizing and reporting Stripe payment transactions by region. Designed for EU businesses, it helps you split your payment data into domestic, intra-EU, and extra-EU transactions for easy VAT reporting.

Features

  • Categorize payments by:
    • Domestic transactions (your company’s country)
    • Intra-EU transactions
    • Extra-EU transactions
  • Simple CLI interface
  • Works with your Stripe API key
  • Easy-to-read regional payment breakdowns
  • Export reports to CSV or HTML format

Requirements

  • Python 3.x
  • uv

Configuration

Create a .env file in the root directory with the following content:

STRIPE_SECRET_KEY=your_stripe_secret_key_here

Usage

To generate a report for a specific month, run the following command:

uv run main.py [--country COUNTRY] [--year YEAR] [--month MONTH] [--export {csv,html}] [--output FILENAME]

Command-Line Arguments

Argument Type Description Default
--country str Country code for domestic transactions FR
--year int Year to report on Current year
--month int Month to report on Previous month
--export str Export format: csv or html None (console output)
--output str Output filename for export Auto-generated

This will generate a categorized report with the following sections:

  • Domestic
  • Intra-EU
  • Extra-EU

Examples

Generate console report:

uv run main.py --country FR --year 2025 --month 05

Export to CSV:

uv run main.py --country FR --year 2025 --month 05 --export csv

Export to CSV with custom filename:

uv run main.py --country FR --year 2025 --month 05 --export csv --output report.csv

Export to HTML:

uv run main.py --country FR --year 2025 --month 05 --export html --output report.html

Export Formats

The tool supports exporting reports in two formats:

CSV Export

  • Includes all transaction details in a structured format
  • Columns: Date, Type, Amount, Currency, Rounded Amount, Country, VAT Number, VAT Applied, Email, Status, Fees, Category
  • Includes summary totals at the end
  • Suitable for spreadsheet analysis

HTML Export

  • Beautiful, responsive web page with modern styling
  • Color-coded amounts (green for payments, red for refunds)
  • Summary dashboard with key metrics
  • Organized by transaction categories
  • Easy to share and view in any web browser

Contributing

We welcome contributions! If you would like to improve LavenderReport, feel free to fork the project and submit a pull request.

License

This project is licensed under the GNU GPL v3 License - see the LICENSE file for details.

About

Command-line tool for effortless VAT reporting with Stripe—tailored for EU businesses.

Topics

Resources

License

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages