Skip to main content

A visualisation tool for Architecture Decision Records

Project description

adr-viewer

Build Status

Show off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content.

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 local build

adr-viewer requires Python 2.7 (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]
  --serve          Serve content at http://localhost: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.

Files for adr-viewer, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size adr-viewer-1.2.0.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page