Skip to content

CHIME Software Guidelines

Introduction

chimefrb/guidelines

CHIME Software Guidelines

chimefrb/guidelines

Introduction
Basic Skills
Basic Skills
- Linux Shell
  Linux Shell
- SSH Remote Connection
  SSH Remote Connection
- Git Version Control
  Git Version Control
- VSCode Text Editor
  VSCode Text Editor
  - Introduction
  - Features
Development Process
Development Process
- Poetry Dependency Control
  Poetry Dependency Control
- Precommit Code Formatting
  Precommit Code Formatting
- Commitizen Commits
  Commitizen Commits
Production Process
Production Process
- CI/CD Pipeline
  CI/CD Pipeline
- Docker Production Builds
  Docker Production Builds
  - Introduction
  - Daemon
  - Image
  - Container
  - Volume
  - Network
  - Swarm
  - Service
  - Stack
Code Features
Code Features
- Click CLIs
  Click CLIs
- Logging Events
- Documentation Generation
  Documentation Generation
- Test Case Design
  Test Case Design
Auxiliary Tools
Auxiliary Tools
- Sanic Server Interface
  Sanic Server Interface
  - Introduction
  - Examples
- CANFAR Network
  CANFAR Network

Introduction¶

A command line interface (CLI) is a text-based user interface that processes commands via a terminal. A well written CLI also provides concise informative comments on how to use the program, most notably under the --help flag. Click is a Python package for creating these command line interfaces in a composable way with as little code as necessary.