Skip to content

Commit 79eabd9

Browse files
✨ add support for asynchronous requests in CLI (#131)
1 parent 26cb4c8 commit 79eabd9

File tree

7 files changed

+313
-107
lines changed

7 files changed

+313
-107
lines changed

docs/guide/python-cli.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,32 @@ python3 -m mindee --help
1010
### Example command help
1111

1212
```shell
13-
python3 -m mindee invoice --help
13+
python3 -m mindee invoice parse --help
1414
```
1515

1616
### Example parse command for Off-the-Shelf document
1717

1818
```shell
19-
python3 -m mindee invoice --invoice-key xxxxxxx /path/to/invoice.pdf
19+
python3 -m mindee invoice parse --key xxxxxxx /path/to/invoice.pdf
20+
```
21+
22+
### Example enqueue command for Off-the-Shelf document (async)
23+
24+
```shell
25+
python3 -m mindee invoice-splitter enqueue --key xxxxxxx /path/to/invoice-splitter.pdf
26+
```
27+
28+
### Example parse-queued command for Off-the-Shelf document (async)
29+
30+
```shell
31+
python3 -m mindee invoice-splitter parse-queued --key xxxxxxx id-of-the-job
2032
```
2133

2234
### Works with environment variables
2335

2436
```shell
2537
export MINDEE_API_KEY=xxxxxx
26-
python3 -m mindee invoice /path/to/invoice.pdf
38+
python3 -m mindee invoice parse /path/to/invoice.pdf
2739
```
2840

2941
### Example parse command for a custom document
@@ -35,7 +47,7 @@ python3 -m mindee custom -u pikachu -k xxxxxxx pokemon_card /path/to/card.jpg
3547
### You can get the full parsed output as well
3648

3749
```shell
38-
python3 -m mindee invoice -o parsed /path/to/invoice.pdf
50+
python3 -m mindee invoice parse -o parsed /path/to/invoice.pdf
3951
```
4052

4153
### In the Git repo, there's a helper script for it

docs/predictions/standard/international.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ International
99
.. include:: ./documents/financial_document_v1.rst
1010
.. include:: ./documents/passport_v1.rst
1111
.. include:: ./documents/shipping_container_v1.rst
12+
.. include:: ./documents/invoice_splitter_v1.rst
1213
.. include:: ./documents/proof_of_address_v1.rst
1314
.. include:: ./documents/cropper_v1.rst

0 commit comments

Comments
 (0)