A package to provide adr-tools to python
This is a project to get a python equivalent of the adr-tools by npryce on github. The tool can make and list and change Architecture Decision Records. For more information on Architecture Decision Records see the page of Joel Parker Henderson on ADRs.
pip install adr-tools-python
python3 -m pip install adr-tools-python --user
By adding a
--upgrade flag, the tool can be updated if a new version is available
adr-init, the directory structure can be initialized. Default, a subdircectory
doc/adr is generated, but if a different directory is wished for, this can be input:
In this case, adrs will be stored in a local folder
foo/. In the main directory, a file called
.adr-dir is generated to indicate to
adr-tools that a different location than the default
doc/adr/ is used. This behaviour was copied from, and should be compatible with the original adr-tools.
adr-init always creates a new adr to say that adrs will be used.
A subject should be given for a new adr:
> adr-new create equal animals > adr-list doc/adr/0001-record-architecture-decisions.md doc/adr/0002-create-equal-animals.md >
ADRs can be superceded from the command line using the
-s option, and be linked by using the
From the documentation of adr-tools:
Multiple -s and -l options can be given, so that the new ADR can supercede
or link to multiple existing ADRs.
E.g. to create a new ADR with the title "Use MySQL Database":
adr new Use MySQL Database
E.g. to create a new ADR that supercedes ADR 12:
adr new -s 12 Use PostgreSQL Database
E.g. to create a new ADR that supercedes ADRs 3 and 4, and amends ADR 5:
adr new -s 3 -s 4 -l "5:Amends:Amended by" Use Riak CRDTs to cope with scale
The same funcitonality is also available in this python version
See above, lists the adrs.
Serving the adrs
If you want the ADRs to be served on a webpage, please look for the python package [adr-viewer](https://pypi.org/project/adr-viewer/
The source code is available on bitbucket. If you're interested in collaborating let me know, and/or send a merge request.
Thanks to Michael Nygard for the original idea of ADRs, WesleyKS for his work on adre (which was inspiring, but not the road I followed), and of course to Npryce for making and documenting the bash toolchain I tried to replicate in Python.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size adr_tools_python-1.0.3-py3-none-any.whl (12.4 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
Hashes for adr_tools_python-1.0.3-py3-none-any.whl