counterweight/camisatoshi-wordpress-reports
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
camisatoshi-wordpress-reports/README.md

1.4 KiB
Raw Permalink Blame History

camisatoshi-wordpress-reports

This repository hosts a Python CLI app that can be used to generate reports by fetching data from wordpress. Its purpose is to generate useful stuff for camisatoshi processes.

How to install

  1. Install the package
  2. In the home directory of the running user, create a folder named .camisatoshi-wordpress-reports.
  3. Copy the provided .env-example file in that directory and fill it with the required params from Woocomerce.

How to run

Check that the API is reachable

camisatoshi-wordpress-reports check-health

Make a report for the UM agreement between two dates

camisatoshi-wordpress-reports generate-um-report --start-date "2023-08-01T00:00:00" --end-date "2023-09-01T00:00:00"

This will generate a file named report.csv in the current working directory.

Make a simple report for the sales of some SKU

camisatoshi-wordpress-reports generate-sku-report --start-date "2023-08-01T00:00:00" --end-date "2023-09-01T00:00:00" --sku TEE-05-BBO-BLACK

This will generate a file named report.csv in the current working directory.

Open issues

  • Pagination is not being managed. The moment we have more than 100 orders, we are gonna run into issues.
  • Some reports will break if the SKU has absolutely no orders. But well, if that happens, there is simply no report to build, so the only serious improvement would be dropping an informative error message.