Skip to main content

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

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.

Metadata

Release files for adr-viewer 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adr-viewer 1.0.1
File Size Uploaded Provenance Actions
adr-viewer-1.0.1.tar.gz 3.0 kB Without provenance Details for adr-viewer-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for adr-viewer 1.0.1
File Interpreter ABI Platform Actions
adr_viewer-1.0.1-py2-none-any.whl Python 2 none any Details for adr_viewer-1.0.1-py2-none-any.whl

Total release size: 7.7 kB

Release files / adr-viewer-1.0.1.tar.gz

Download URL adr-viewer-1.0.1.tar.gz
Size 3.0 kB
Tags Source
SHA-256 checksum
How to use checksums
08efbeb707b1eef24b5306287c7cf0a9bc28c94a271f8686b42451e234e98bcc
BLAKE2b-256 checksum
How to use checksums
bd733ee144ef876d5866b6e92789d7787a11424bfade16e27bfd5de00289840f
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / adr_viewer-1.0.1-py2-none-any.whl

Download URL adr_viewer-1.0.1-py2-none-any.whl
Size 4.7 kB
Tags Python 2
SHA-256 checksum
How to use checksums
1d3f7b9b9f1db02437ccc18e60a699984e79c702772580d4af8be1ab496ad8d6
BLAKE2b-256 checksum
How to use checksums
840bab8214037a556243dfe849583d4d8bc0c67cdfc89cbd29743566c54569fa
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for adr-viewer 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page