From 81b2159329d363df6f6db7acb5b7ea655602ec5b Mon Sep 17 00:00:00 2001 From: timothycarambat <rambat1010@gmail.com> Date: Fri, 16 Jun 2023 17:26:42 -0700 Subject: [PATCH] reorder docs --- collector/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/collector/README.md b/collector/README.md index c7af796be..3dbb1357a 100644 --- a/collector/README.md +++ b/collector/README.md @@ -34,6 +34,12 @@ As files are processed you will see data being written to both the `collector/ou If collection fails at any point in the process it will pick up where it last bailed out so you are not reusing credits. +### Running the document processing API locally +From the `collector` directory with the `v-env` active run `flask run --host '0.0.0.0' --port 8888`. +Now uploads from the frontend will be processed as if you ran the `watch.py` script manually. + +**Docker**: If you run this application via docker the API is already started for you and no additional action is needed. + ### How to get a Google Cloud API Key (YouTube data collection only) **required to fetch YouTube transcripts and data** - Have a google account @@ -42,10 +48,4 @@ If collection fails at any point in the process it will pick up where it last ba -  - [Enable YouTube Data APIV3](https://console.cloud.google.com/apis/library/youtube.googleapis.com) - Once enabled generate a Credential key for this API -- Paste your key after `GOOGLE_APIS_KEY=` in your `collector/.env` file. - -### Running the document processing API locally -From the `collector` directory with the `v-env` active run `flask run --host '0.0.0.0' --port 8888`. -Now uploads from the frontend will be processed as if you ran the `watch.py` script manually. - -**Docker**: If you run this application via docker the API is already started for you and no additional action is needed. \ No newline at end of file +- Paste your key after `GOOGLE_APIS_KEY=` in your `collector/.env` file. \ No newline at end of file