Included some stuff in the readme
This commit is contained in:
parent
54fa31f988
commit
99a63b9ba9
1 changed files with 27 additions and 1 deletions
28
README.md
28
README.md
|
|
@ -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.
|
||||
|
||||
|
||||
# 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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue