Shout to excellent adr-tools project on which
ADR-py
is based on
This Python script is designed to help software development teams document their architecture decisions using Architecture Decision Records (ADRs). ADRs are a lightweight and effective way to capture important decisions made during the design and development of a software system, and to keep track of their rationale and implications over time.
The script creates ADR files in a predefined format, following the principles of Michael Nygard's ADR template. Each ADR file is a Markdown document with a unique name that includes a sequential number and a title, which is automatically generated based on the information provided by the user.
pip install adr
Usage:
$ adr [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.Commands:
init
: Initialize ADR directory with first ADR in given PATHnew
: Create new ADR with given NAMEinit
Initialize ADR directory with first ADR in given PATH
Usage:
$ adr init [OPTIONS] [PATH]
Arguments:
[PATH]
: Path in where ADRs should reside. If not provided Path will be extracted from pyproject.tomlOptions:
--help
: Show this message and exit.new
Create new ADR with given NAME
Usage:
$ adr new [OPTIONS] NAME
Arguments:
NAME
: Name of new ADR. Longer names (with spaces) should be put in quotation marks. [required]Options:
adr --help
: Show this message and exit.The generated ADR files follow the template proposed by Michael Nygard in his book "Documenting Architecture Decisions." The template consists of the following sections:
Using ADRs has several benefits for software development teams, including: