Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.22 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.22 KB
Raw

gcf-data-mapper

A CLI tool to map the GCF data to the required JSON format for bulk-import.

  • Developers please read the DEVELOPERS.md file for more information.

  • This tool is designed to map this GCF data

Installation

This package is not available on PyPI. To install it, you need to build the package and install it locally.

make build # Ensure you have the package built

# Install the package into your environment
poetry run pip install dist/gcf_data_mapper-<version>-py3-none-any.whl

Goto the releases page to find the latest version.

Usage

If --output_file is not passed, by default an output file called output.json will be created in the current directory if it does not already exist.

If --gcf_projects_file, mcf_projects_file or mcf_docs_file is not passed, by default the GCF mapper tool will look for a sub-folder in the current working directory called data with the following files in it:

gcf_data_mapper --gcf_projects_file FILENAME --mcf_projects_file FILENAME --mcf_docs_file FILENAME --output_file FILENAME