Skip to main content

A visualisation tool for Architecture Decision Records

Project description

adr-viewer

Latest Version

Show off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content. Include diagrams in Mermaid format using code blocks/fences, e.g. test ADR 5.

Examples

  • Example above using Nat Pryce's adr-tools project
  • This project exposes its own Architecture Decision Records here

Installation

From PyPI

$ pip install adr-viewer

From Homebrew

$ brew install adr-viewer

See also the adr-viewer formula page.

From local build

adr-viewer requires Python 3.7 or higher (with Pip)

$ git clone https://github.com/mrwilson/adr-viewer
$ pip install -r requirements.txt
$ python setup.py install

Usage

Usage: adr-viewer [OPTIONS]

Options:
  --adr-path TEXT  Directory containing ADR files.  [default: doc/adr/]
  --output TEXT    File to write output to.  [default: index.html]
  --title TEXT     The project title   [default: the basename of the current directory]
  --serve          Serve content at http://localhost:8000/
  --port INT       Custom server port [default: 8000]
  --help           Show this message and exit.

The default for --adr-path is doc/adr/ because this is the default path generated by adr-tools.

Supported Record Types

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adr_viewer-1.4.0.tar.gz (111.0 kB view details)

Uploaded Source

File details

Details for the file adr_viewer-1.4.0.tar.gz.

File metadata

  • Download URL: adr_viewer-1.4.0.tar.gz
  • Upload date:
  • Size: 111.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for adr_viewer-1.4.0.tar.gz
Algorithm Hash digest
SHA256 9a2f02a9feb3a6d03d055dd8599b20d34126f8e755b4b4ee1a353ecbbd590cef
MD5 1facd6f07628034b458ab64935b42c9b
BLAKE2b-256 1b720f787da38d0f9d69c06b31d8f412735ed4fad383edd7f7d2286f4fc7b5b0

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page