Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 1.34 KB

DEVELOPMENT.md

File metadata and controls

41 lines (35 loc) · 1.34 KB

Development

Workflow

  • clone repo
  • Configure environment vars (if needed): cp env.dist local.env
  • Install Dependencies: docker-compose run --rm install_vendors
  • Run example: docker-compose run --rm tools example hello world
  • Place new commands in this format command/cmd_${command_name}.py "${command_name}" should be replaced with the name of your command.
  • Use command/cmd_example.py as a basic example to start from.
  • If you run into a weird build error, try removing your vendors/* and running dep install command cleanly.

Dependencies

  • Click
    • [Click] provides a framework for base CLI features and code faster.
  • Boto3
    • [Boto3] provides python library to make AWS API calls.
  • Fabric
    • [Fabric] provides python library to support SSH connections.
  • paramiko
    • [Paramiko] provides python ssh library that fabric uses.
    • version pinned to 2.8.1 due to some changes that broke previous working functionality.
  • PyYAML
    • [PyYAML] provides yaml parsing for local configuration files.

Development Dependencies

  • Docker
  • Docker compose
  • Git

References