bridge.cli Function Signatures¶
This page shows the CLI function signatures with docstrings included - for the full CLI source see this.
- bridge.cli.generate_paperlike_crf_pdf(data_dictionary_csv: str, arc_version: str | None = '1.2.2', redcap_db_name: str | None = 'Generic', language: str | None = 'English', paperlike_details_csv: str | None = None, supplemental_phrases_csv: str | None = None, output_path: str | None = None) bytes¶
-
bytes: Returns a PDF of the paperlike CRF.- Parameters:
-
- data_dictionary_csvstr
-
The local path to the data dictionary CSV file.
- arc_versionstr, default=”1.2.2”
-
Optional ARC version string, defaults to the current latest version
"1.2.2"(as of 15.05.2026). - redcap_db_namestr, default=””
-
Optional REDCap database name, defaults to
"". - languagestr, default=”English”
-
Optional PDF language setting, defaults to
"English". - paperlike_details_csvstr, default=None
-
Optional paperlike form details CSV, defaults to
None. - supplemental_phrases_csvstr, default=None
-
Optional supplemental phrases CSV, defaults to
None. - output_pathstr, default=None
-
Optional output path string, defaults to
None. IfNonethen output file is created in a subfolder namedoutputcreated in the working directory.
- Returns:
-
- bytes
-
The CRF PDF object as bytes.
- bridge.cli.generate_paperlike_crf_word(data_dictionary_csv: str, include_descriptive_rows: bool = False, output_path: str | None = None) bytes¶
-
bytes: Returns a Word document (.docx) of the paperlike CRF.- Parameters:
-
- data_dictionary_csvstr
-
The local path to the data dictionary CSV file.
- include_descriptive_rowsbool, default=False
-
Include source rows with descriptive field type.
- output_pathstr, default=None
-
Optional output path string, defaults to
None. IfNonethen output file is created in a subfolder namedoutputcreated in the working directory.
- Returns:
-
- bytes
-
The CRF Word document object as bytes.