counterweight/camisatoshi-wordpress-reports
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
40 commits 4 branches 0 tags 91 KiB
Find a file
counterweight b00a95cee5
Rename
2023-09-03 05:16:59 +02:00
camisatoshi_wordpress_reports Rename 2023-09-03 05:16:59 +02:00
tests Create poetry template 2023-08-02 19:12:43 +02:00
.env-example Modify .env example 2023-08-02 19:47:38 +02:00
.gitignore Initial commit 2023-08-02 16:56:40 +00:00
poetry.lock Added loading api params from dotenv file 2023-08-02 19:42:43 +02:00
pyproject.toml Added loading api params from dotenv file 2023-08-02 19:42:43 +02:00
README.md Included some stuff in the readme 2023-09-03 05:15:26 +02:00

README.md

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"c

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.