Skip to content

Latest commit

 

History

History
131 lines (95 loc) · 4.24 KB

README.md

File metadata and controls

131 lines (95 loc) · 4.24 KB
Raw

HR Quickbase (HRQB) Client

A python CLI application for managing data in the Library HR Quickbase instance.

Overview

Library HR uses Quickbase to manage and report on employee data. This application is responsible for extracting data from the Data Warehouse, extracting data from data managed by Library HR, transforming this to a data model pre-established in Quickbase, and loading that data. This CLI application serves as a simple pipeline to perform this work.

This pipeline will be a Python CLI application, with commands applicable to the data loads and management tasks required, that run on a schedule as an ECS container in AWS via EventBridge rules.

See additional diagrams and documentation in the docs folder:

Development

  • To preview a list of available Makefile commands: make help
  • To install with dev dependencies: make install
  • To update dependencies: make update
  • To run unit tests: make test
  • To lint the repo: make lint
  • To run the app: pipenv run hrqb --help

Environment variables

Required

SENTRY_DSN=# If set to a valid Sentry DSN, enables Sentry exception monitoring. This is not needed for local development.
WORKSPACE=# Set to `dev` for local development, this will be set to `stage` and `prod` in those environments by Terraform.
LUIGI_CONFIG_PATH=hrqb/luigi.cfg # this env var must be set, pointing to config file in hrqb folder
QUICKBASE_API_URL=# Quickbase API base URL
QUICKBASE_API_TOKEN=# Quickbase API token
QUICKBASE_APP_ID=# Quickbase App ID
DATA_WAREHOUSE_CONNECTION_STRING=# Data Warehouse SQLAlchemy connection string, e.g. oracle+oracledb://user1:pass1@example.org:1521/ABCDE

Optional

DYLD_LIBRARY_PATH=/usr/local/lib:$DYLD_LIBRARY_PATH # used when developing on arm64 architecture + Rosetta2 environment
TARGETS_DIRECTORY=# Location to store Task Targets, overriding application default of "output"
LUIGI_NUM_WORKERS=# Number of processes for luigi to run tasks in parallel.  If not set, defaults to 1 in application.

CLI Commands

ping

Usage: ping [OPTIONS]

  Debug command to test application initializes okay.

Options:
  --help  Show this message and exit.

pipeline [Command Group]

Usage: -c pipeline [OPTIONS] COMMAND [ARGS]...

Options:
  -p, --pipeline TEXT             Pipeline Task class name to be imported from
                                  configured pipeline module, e.g.
                                  'MyPipeline'  [required]
  -pm, --pipeline-module TEXT     Module where Pipeline Task class is defined.
                                  Default: 'hrqb.tasks.pipelines'.
  -pp, --pipeline-parameters TEXT
                                  Comma separated list of luigi Parameters to
                                  pass to HRQBPipelineTask, e.g.
                                  'Param1=foo,Param2=bar'.
  -t, --task TEXT                 Select a target task for pipeline sub-
                                  commands (e.g. remove-data, run, etc.)
  -h, --help                      Show this message and exit.

Commands:
  remove-data  Remove target data from pipeline tasks.
  run          Run a pipeline.
  status       Get status of a pipeline's tasks.

pipeline status

Usage: -c pipeline status [OPTIONS]

  Get status of a pipeline's tasks.

Options:
  -h, --help  Show this message and exit.

pipeline remove-data

Usage: -c pipeline remove-data [OPTIONS]

  Remove target data from pipeline tasks.

  If argument --task is passed to parent 'pipeline' command, only this task
  will have its target data removed.

Options:
  -h, --help  Show this message and exit.

pipeline run

Usage: -c pipeline run [OPTIONS]

  Run a pipeline.

  If argument --task is passed to parent 'pipeline' command, only this task,
  and the tasks it requires, will run.

Options:
  --cleanup   Remove target data for all tasks in pipeline after run.
  -h, --help  Show this message and exit.