Skip to content

Commit 08a05e8

Browse files
tanishq-idstanishq-idspre-commit-ci[bot]
authored
Kpi (#299)
* changes in kpi_curator_main.py Signed-off-by: tanishq-ids <tanishq.more@incestmentdataservices.com> * added folderrizer command in cli Signed-off-by: tanishq-ids <tanishq.more@incestmentdataservices.com> * added more folders to folderrizer Signed-off-by: tanishq-ids <tanishq.more@incestmentdataservices.com> * Chore: pre-commit autoupdate * precommit errors solved Signed-off-by: tanishq-ids <tanishq.more@incestmentdataservices.com> * Chore: pre-commit autoupdate * Update README.rst added info about folderrizer Signed-off-by: tanishq-ids <166009643+tanishq-ids@users.noreply.github.com> --------- Signed-off-by: tanishq-ids <tanishq.more@incestmentdataservices.com> Signed-off-by: tanishq-ids <166009643+tanishq-ids@users.noreply.github.com> Co-authored-by: tanishq-ids <tanishq.more@incestmentdataservices.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 5fd1843 commit 08a05e8

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,21 @@ Afterwards, you can use the tooling as a CLI tool by typing::
3434

3535
We are using Typer to provide a user-friendly CLI. All details and help will be shown within the CLI itself and are not described here in more detail.
3636

37-
Example 1: Extracting Data from PDFs
38-
------------------------------------
37+
Setting Up Folder Structure
38+
---------------------------
3939

40-
Assume the folder structure is as follows:
40+
To quickly set up the required folder structure, just run this command::
4141

42-
.. code-block:: text
42+
$ osc-transformer-presteps make-folder-structure run-folder-structure-maker
4343

44-
project/
45-
├-input/
46-
│ ├-file_1.pdf
47-
│ ├-file_2.pdf
48-
│ └─file_3.pdf
49-
├-logs/
50-
└─output/
44+
This will automatically create the necessary folders for your project.
45+
46+
47+
Example 1: Extracting Data from PDFs
48+
------------------------------------
5149

52-
Now, after installing ``osc-transformer-presteps``, run the following command to extract data from the PDFs to JSON::
50+
Now, after installing ``osc-transformer-presteps``,and making into the folder-structure, move into the created folder.
51+
Finally, run the following command to extract data from the PDFs to JSON::
5352

5453
$ osc-transformer-presteps extraction run-local-extraction 'input' --output-folder='output' --logs-folder='logs' --force
5554

0 commit comments

Comments
 (0)