SAT Developer Documentation

This developer documentation describes how to contribute to the sat Python project.

To develop a new sat subcommand, start with the first section below and then visit the links in the sections below as needed.

SAT Project Structure

See SAT Project Structure for a description of how the sat Python project is structured and how to add a new subcommand within it.

See API Requests in SAT for information on making authenticated requests to service APIs behind the API gateway in the SAT code base.

See Logging in SAT for an overview of how logging is done in SAT and instructions on adding logging to your subcommands.

See Configuration in SAT for details on how the sat command-line utility is configured and how to add new configuration options.

See Documentation in SAT for details on how the sat commands are documented in man pages and how to modify existing man pages or add new ones.

See Python Style Guidelines for information on the Python style guidelines that sat code should follow.

See SAT Python Dependencies for information on how to add, remove and update SAT Python dependencies.