CLI

Enrich provides a simple command line interface for development and management of the enrich platform modules.

Local development of transforms requires you to first bootstrap the environment. This includes workspace, environment variables etc. A rough set of steps is shown below.

$ enrichpkg start 
[ 1] Understand Enrich and SDK
[ 2] Create an environment/context file
[ 3] Initialize workspace, siteconf and versionmap
[ 4] Change dir to $ENRICH_CUSTOMERS
[ 5] GIT checkout a code repository
[ 6] Change to checked out repository
[ 7] Create working space
[ 8] Create usecase
[ 9] Change to usecase
[10] Bootstrap a transform
[11] Install repo-specific requirements
[12] Test the transform
[13] Bootstrap a pipeline
[14] Check pipeline
[15] Bootstrap a workflow
[16] Check workflow

$ enrichpkg env
Usage: enrichpkg env [OPTIONS] COMMAND [ARGS]...

  Setup the environment. Environment includes:

      (a) Workspace for enrich to work
      (b) Minimal configuration

  This can be specified using environment variables and/or 'context' file.

  The absolute minimal required environment variable is ENRICH_ROOT (path to
  enrich workspace e.g., ~/enrich)

Options:
  --help  Show this message and exit.

Commands:
  check              Check environment
  dump-versionmap    Show versionmap
  populate           Populate the directories
  sample-context     Generate sample context file
  sample-djangoenv   Sample django-env environment variables.
  sample-siteconf    Generate sample siteconf
  sample-versionmap  Generate sample versionmap
  show-credential    Generate sample siteconf