adr

ADR-py

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.

Prerequisites

• Python 3.11 installed on your system.
• Basic knowledge of command-line interface (CLI) usage.

Installation

• pip install adr

How to Use

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 PATH
• new: Create new ADR with given NAME

Configuration and metadata

ADR-py works in ordinary documentation repositories. If no path is supplied and no configuration is found, ADRs are created in the current working directory.

The configuration search order is:

1. An explicit path passed to adr init.
2. An explicit TOML file passed with --config.
3. .adrpy.toml in the current working directory.
4. [tool.adrpy] in the current working directory's pyproject.toml.
5. The current working directory.

For a non-Python documentation repository, create .adrpy.toml:

dir = "docs/adr"

The same file can be supplied to both commands:

$ adr init --config .adrpy.toml
$ adr init --config .adrpy.toml --status proposed --tag architecture --tag process
$ adr new --config .adrpy.toml "Use PostgreSQL" --status proposed --tag database --tag persistence

Generated ADRs start with YAML front matter containing an immutable UUID id, a numeric ordinal, title, status, ISO date, a list of tags, and UUID relationship fields supersedes and superseded_by. New ADRs default to proposed; pass --status to select another allowed status and repeat --tag for multiple tags. The front matter is intentionally machine-readable while the Markdown body remains editable in any text editor.

init

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.toml

Options:

• --help: Show this message and exit.

• --status: Initial status; defaults to proposed.

• --tag: Tag to add; repeat for multiple tags.

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.

• --status: Initial status; defaults to proposed.

• --tag: Tag to add; repeat for multiple tags.

ADR Template

The generated ADR files follow the template proposed by Michael Nygard in his book "Documenting Architecture Decisions." The template consists of the following sections:

• Title: The title of the ADR.
• Status: The current status of the decision (e.g., proposed, accepted, rejected).
• Context: The context and background information that led to the decision.
• Decision: The decision made and its rationale.
• Consequences: The potential consequences and trade-offs of the decision.

Benefits of ADRs

Using ADRs has several benefits for software development teams, including:

• Documentation: ADRs provide a written record of important architectural decisions, making it easier for team members to understand the reasons behind past decisions.
• Communication: ADRs serve as a communication tool for discussing and documenting design decisions, facilitating collaboration among team members.
• Decision-making: ADRs encourage thoughtful decision-making by requiring the team to consider the context, rationale, and potential consequences of each decision.
• Transparency: ADRs promote transparency by making architectural decisions visible and accessible to the entire team, fostering a culture of shared understanding and accountability.
• Knowledge sharing: ADRs help capture the collective knowledge and experience of the team, enabling future team members to learn from past decisions and avoid repeating mistakes.