Metadata-Version: 2.1
Name: adr-tools-python
Version: 1.0.1
Summary: A package to provide adr-tools to python
Home-page: https://bitbucket.org/tinkerer_/adr-tools-python/
Author: Victor Sluiter
Author-email: vsluiter@yahoo.com
License: MIT
Description: # README #
        
        This is a project to get a python equivalent of the adr-tools by npryce on [github][adr-tools]. The tool can make and list and change Architecture Decision Records
        
        ## Installation
        
        ```
        pip install adr-tools-python
        ```
        
        or
        
        ```
        python3 -m pip install adr-tools-python --user
        ```
        By adding a `--upgrade` flag, the tool can be updated if a new version is available
        
        ## Usage
        
        ### adr-init
        
        With `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:
        
        ```
        adr-init foo
        ```
        
        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. 
        
        ### adr-new
        
        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 `-l` option. 
        
        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
        
        ### adr-list
        
        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/
        
        ## Source, contribution
        
        The source code is available on [bitbucket](https://bitbucket.org/tinkerer_/adr-tools-python/). If you're interested in collaborating let me know, and/or send a merge request.
        
        ## Thanks
        
        Thanks to Michael Nygard for the original [idea of ADRs](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), WesleyKS for his work on [adre](https://github.com/wesleyks/adre/tree/master/adre) (which was inspiring, but not the road I followed), and of course to Npryce for making and documenting the [bash toolchain][adr-tools] I tried to replicate in Python.
        
        [adr-tools]: https://github.com/npryce/adr-tools
Keywords: adr,architecture decision record
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
