Toolkit for using spreadsheets to create and modify RapidPro flows.
pip install rpft
rpft --helpThe CLI supports the following subcommands:
create_flows: create RapidPro flows (in JSON format) from spreadsheets using content indexflows_to_sheets: convert RapidPro flows (in JSON format) into spreadsheetsconvert: save input spreadsheets as JSONsave_data_sheets: save input spreadsheets as nested JSON using content index - an experimental feature that is likely to change.
Full details of the available options for each can be found via the help feature:
rpft <subcommand> --helpBelow is a concrete example of a valid execution of the command line tool using create_flows to convert a set of spreadsheets into RapidPro flows. The line breaks are merely for improving readability; the command would also be valid on a single line.
cd tests/input/example1
PYTHONPATH=. rpft create_flows \
--output flows.json \
--datamodels=nestedmodel \
--format=csv \
csv_workbookThe following is an example of the flows_to_sheets operation, essentially the reverse of create_flows.
mkdir output
rpft flows_to_sheets tests/output/all_test_flows.json output --strip_uuids- Add the package
rpftas a dependency of your project e.g. in requirements.txt or pyproject.toml - Import the
create_flowsfunction - Call
create_flowsto convert spreadsheets to flows
from rpft.converters import create_flows
sources = ["workbook.xlsx", "csv_workbook"]
create_flows(
sources, "flows.json", "csv", data_models="your_project.models"
)It should be noted that this project is still considered beta software that may change significantly at any time.
The expected contents of the input spreadsheets is documented separately:
The toolkit can fetch spreadsheets from Google Sheets. See the setup instructions for details.
For instructions on how to set up your development environment for developing the toolkit, see the development page.