A visualisation tool for Architecture Decision Records
Project description
adr-viewer
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
Release history Release notifications | RSS feed
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.1.1.tar.gz
(4.3 kB
view details)
Built Distributions
adr_viewer-1.1.1-py2.7.egg
(8.1 kB
view details)
File details
Details for the file adr-viewer-1.1.1.tar.gz.
File metadata
- Download URL: adr-viewer-1.1.1.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/2.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 41f2c32551633d18d4fa054d608af60c780304522430f5a65ff652619f6c7dbf |
|
| MD5 | 2878667d434a5bf984efc3c9c0c0f28e |
|
| BLAKE2b-256 | 748c0c2ce488c776668c7bc6fba5631d5b5d41dce84844d8929dc50d29066738 |
File details
Details for the file adr_viewer-1.1.1-py2.7.egg.
File metadata
- Download URL: adr_viewer-1.1.1-py2.7.egg
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/2.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1c45f934a8b2ce6a2347b5f05cd3b8e895abe3309bc8d0b23c0681544c960ba9 |
|
| MD5 | 35ed74fbb38e288e3be39f8d389a79c2 |
|
| BLAKE2b-256 | 8516fcf2c029e5bb5bc63a2eabf9abba42707c68bfc40ff86f2270930a14eec5 |
File details
Details for the file adr_viewer-1.1.1-py2-none-any.whl.
File metadata
- Download URL: adr_viewer-1.1.1-py2-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/2.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a1cda3100f233b97c5164e170b01bc8033048316a07f0a1f1fb42d9e30b4acd9 |
|
| MD5 | a5d35b9ecfb93bf0de82b471ed0ba303 |
|
| BLAKE2b-256 | 03400e9a966af7b399e46e5ab97b152292e2427e481e5e2c537ca4a72b46e883 |
