<h1 style="margin-left:0px;"><strong>ADR Tool in Python</strong></h1><p style="margin-left:0px;">A command-line tool for working with a log of <a href="http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions">Architecture Decision Records</a> (ADRs). The ADRs will each be a markdown file (.md) of a specific template.&nbsp;</p><h4 style="margin-left:0px;"><strong>Installation</strong></h4><p style="margin-left:40px;"><code>pip3 install adr-tools-python</code></p><h4 style="margin-left:0px;"><strong>Useful Commands</strong></h4><ul style="list-style-type:revert;"><li>To create an ADR directory in the root of your project<br><code>adr-init</code> . The default directory would be <code>doc/adr</code> .</li><li>To create an ADR directory in a custom location,&nbsp;</li></ul><p style="margin-left:40px;"><code>adr-init doc/architecture/decisions</code></p><ul style="list-style-type:revert;"><li>To list all the adrs in the project.&nbsp;</li></ul><p style="margin-left:40px;"><code>adr-list</code></p><ul style="list-style-type:revert;"><li>To view the configuration of the adr tool,&nbsp;</li></ul><p style="margin-left:40px;"><code>adr-config</code></p><ul style="list-style-type:revert;"><li>To Create Architecture Decision Records , use <code>adr-new</code></li></ul><p style="margin-left:40px;"><code>adr-new Implement as Windows batch scripts</code></p><ul style="list-style-type:revert;"><li>To create a new ADR that supersedes a previous one (ADR 3, for example), use the -s option.&nbsp;</li></ul><p style="margin-left:40px;"><code>adr-new -s 3 Implement as Unix shell scripts</code></p><p style="margin-left:0px;"><strong>References:</strong></p><ol style="list-style-type:decimal;"><li><a href="https://pypi.org/project/adr-tools-python/">https://pypi.org/project/adr-tools-python/</a></li><li><a href="https://github.com/npryce/adr-tools">https://github.com/npryce/adr-tools</a></li></ol>

large_Designer (7).png

ADR Tool in Python

Similar stories

Get our stories delivered

© Nirmitee.io. 2023, India. All rights reserved