Repo reorganisation

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Produce RapidPro flows
+name: Produce Poll Wrappers
 on:
     workflow_dispatch
 
@@ -12,18 +12,21 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Node dependencies
+        working-directory: technical
         run: npm ci
 
       - name: Install Python dependencies
+        working-directory: technical
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
 
       - name: Run pipeline
-        run: python -m parenttext_pipeline.cli pull_data compile_flows
+        working-directory: technical
+        run:  python -m parenttext_pipeline.cli pull_data compile_flows
 
-      - name: Publish output folder
+      - name: Publish poll_wrappers.json
         uses: actions/upload-artifact@v3
         with:
-          name: Output Files
-          path: output
+          name: Poll Wrappers File
+          path: technical/output/poll_wrappers.json

README.md

@@ -1,13 +1,14 @@
 # Example poll wrapper
 
-This project builds RapidPro flows
+This project creates the wrapper flows that should be used alongside a poll within RapidPro. There is a pipeline which takes the csv inputs in the 'poll data' folder and creates the wrappers.
+
 ## Usage
 
 The pipeline is intended to be run by triggering a Github Actions workflow or by running commands on the command line.
 
-## Github actions (work in progress)
+## Github actions
 
-1. Navigate to the page for the [Produce RapidPro Flows][1] action
+1. Navigate to the page for the [Produce Poll Wrappers][1] action
 2. Click on the _Run workflow_ button; a drop-down will appear
 3. Make sure _Branch_ is set to _main_
 4. Click on the green _Run workflow_ button
@@ -20,6 +21,7 @@ These steps need to be followed if you want to run the pipeline from the command
 
 1. Clone or fork the repo to a local folder
 1. Install Python >= 3.8
+1. Change to the 'techical' folder where the config.json file is held and all code should be run from `cd technical`
 1. Create a Python virtual environment `python -m venv .venv`
 1. Activate the environment:
     - Linux: `source .venv/bin/activate`
@@ -28,11 +30,9 @@ These steps need to be followed if you want to run the pipeline from the command
 1. Install project Python dependencies `pip install -r requirements.txt`
 1. Install latest Node and NPM Long-Term Support (LTS) versions
 1. Install project Node dependencies `npm install`
-1. Make sure you have a correct `credentials.json` file in the same directory as the cloned repo.
 
 ## Run
 
-
 ```
 python -m parenttext_pipeline.cli pull_data compile_flows 
 ```

poll_data/poll_metadata.csv

@@ -1,2 +1,2 @@
 ID,poll_type,poll_name
-ExampleDummyPoll,poll_type,
+ExampleDummyPoll,poll_type,HIV Poll

config.json → technical/config.json

@@ -19,7 +19,7 @@
             "subformat": "csv",
             "files_dict": {
                 "workspace_data": "workspace_data",
-                "poll_data": "poll_data"
+                "poll_data": "../poll_data"
             }
         },
         "expiration_times": {

technical/input/meta.json

@@ -0,0 +1,5 @@
+{
+  "pipeline_version": "1.0.1.dev11+g0f9c6d8",
+  "config_version": "1.0.0",
+  "pull_timestamp": "2024-11-07 14:31:26.485539+00:00"
+}