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

Included some stuff in the readme

Browse source
This commit is contained in:
counterweight 2023-09-03 05:15:26 +02:00
parent 54fa31f988
commit 99a63b9ba9
Signed by: counterweight
GPG key ID: 883EDBAA726BD96C
1 changed files with 27 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -10,5 +10,31 @@ This repository hosts a Python CLI app that can be used to generate reports by f
3. Copy the provided `.env-example` file in that directory and fill it with the required params from Woocomerce. 3. Copy the provided `.env-example` file in that directory and fill it with the required params from Woocomerce.
# Open issues ## How to run
### Check that the API is reachable
```shell
camisatoshi-wordpress-reports check-health
```
### Make a report for the UM agreement between two dates
```shell
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
```shell
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. - Pagination is not being managed. The moment we have more than 100 orders, we are gonna run into issues.