{ "info": { "author": "Victor Sluiter", "author_email": "vsluiter@yahoo.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# README #\n\nThis 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. For more information on Architecture Decision Records see the page of [Joel Parker Henderson on ADRs](https://github.com/joelparkerhenderson/architecture_decision_record).\n\n## Installation\n\n```\npip install adr-tools-python\n```\n\nor\n\n```\npython3 -m pip install adr-tools-python --user\n```\nBy adding a `--upgrade` flag, the tool can be updated if a new version is available\n\n## Usage\n\n### adr-init\n\nWith `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:\n\n```\nadr-init foo\n```\n\nIn 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. \n\n### adr-new\n\nA subject should be given for a new adr:\n\n```\n> adr-new create equal animals\n> adr-list\ndoc/adr/0001-record-architecture-decisions.md\ndoc/adr/0002-create-equal-animals.md\n> \n```\nADRs can be superceded from the command line using the `-s` option, and be linked by using the `-l` option. \n\nFrom the documentation of [adr-tools][]:\n\n> # Multiple -s and -l options can be given, so that the new ADR can supercede\n> # or link to multiple existing ADRs.\n> ##\n> # E.g. to create a new ADR with the title \"Use MySQL Database\":\n> ##\n> # adr new Use MySQL Database\n> ##\n> # E.g. to create a new ADR that supercedes ADR 12:\n> ##\n> # adr new -s 12 Use PostgreSQL Database\n> ##\n> # E.g. to create a new ADR that supercedes ADRs 3 and 4, and amends ADR 5:\n> ##\n> # adr new -s 3 -s 4 -l \"5:Amends:Amended by\" Use Riak CRDTs to cope with scale\n> ##\n\nThe same funcitonality is also available in this python version\n\n### adr-list\n\nSee above, lists the adrs.\n\n### Serving the adrs\n\nIf you want the ADRs to be served on a webpage, please look for the python package [adr-viewer](https://pypi.org/project/adr-viewer/\n\n## Source, contribution\n\nThe 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.\n\n## Thanks\n\nThanks 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.\n\n[adr-tools]: https://github.com/npryce/adr-tools\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/tinkerer_/adr-tools-python/", "keywords": "adr,architecture decision record", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "adr-tools-python", "package_url": "https://pypi.org/project/adr-tools-python/", "platform": "", "project_url": "https://pypi.org/project/adr-tools-python/", "project_urls": { "Homepage": "https://bitbucket.org/tinkerer_/adr-tools-python/" }, "release_url": "https://pypi.org/project/adr-tools-python/1.0.3/", "requires_dist": [ "argparse" ], "requires_python": ">=3", "summary": "A package to provide adr-tools to python", "version": "1.0.3" }, "last_serial": 5396186, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "1b1cce0198f13c6f1f12f1ba5f2ac938", "sha256": "fef3123b50173959c853bbfe40eec71a551d567f36db771b25bbfc76e890ee21" }, "downloads": -1, "filename": "adr_tools_python-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "1b1cce0198f13c6f1f12f1ba5f2ac938", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4126, "upload_time": "2019-06-13T14:36:32", "url": "https://files.pythonhosted.org/packages/c3/40/c85263cc8722a2a37dd756713bac0d3b38a7860584891bbbe4f102718d03/adr_tools_python-0.0.1-py3-none-any.whl" } ], "0.0.10": [ { "comment_text": "", "digests": { "md5": "16763b4323c096caf6aaa848605d702e", "sha256": "a0f8a3bb0f91e18e944db15950e41ee9985e0df67ebe4df40ed477241853333c" }, "downloads": -1, "filename": "adr_tools_python-0.0.10-py3-none-any.whl", "has_sig": false, "md5_digest": "16763b4323c096caf6aaa848605d702e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 15436, "upload_time": "2019-06-08T22:01:03", "url": "https://files.pythonhosted.org/packages/e2/88/666ea39438d310a01bfea33d3b74edf65472c3e9be06b803aa0e09664bed/adr_tools_python-0.0.10-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dfa605a4c88e1db2f0b5ef24371dc690", "sha256": "e93bf2aa9961901b551440ada8ee114d316c23eb484419afad8f2d1e740f9359" }, "downloads": -1, "filename": "adr-tools-python-0.0.10.tar.gz", "has_sig": false, "md5_digest": "dfa605a4c88e1db2f0b5ef24371dc690", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 7863, "upload_time": "2019-06-08T22:03:02", "url": "https://files.pythonhosted.org/packages/2e/7d/8e34e082ae7733f1a465a8c4c5548c694d767199801525c914a194d5547f/adr-tools-python-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "f069441f3787d7a36a85535af6cdd8b7", "sha256": "26a7453fcadbb5ac2417a64c9e55a6ff0b0ccd1cda3bc2b49b924f0b21cbbfd2" }, "downloads": -1, "filename": "adr_tools_python-0.0.11-py3-none-any.whl", "has_sig": false, "md5_digest": "f069441f3787d7a36a85535af6cdd8b7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 15441, "upload_time": "2019-06-08T22:01:05", "url": "https://files.pythonhosted.org/packages/4a/8e/cdc730f9f12cb54ab28c37bfae858c23c97279229662c738b5ba2c938e29/adr_tools_python-0.0.11-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "62d9ea0df50eb1201c06494d3747b9dd", "sha256": "48f5da70c125b3a9838d36648d455c3b82c70e7436d5ce3ab4cf77c11d02b931" }, "downloads": -1, "filename": "adr-tools-python-0.0.11.tar.gz", "has_sig": false, "md5_digest": "62d9ea0df50eb1201c06494d3747b9dd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 7857, "upload_time": "2019-06-08T22:03:04", "url": "https://files.pythonhosted.org/packages/0a/c1/92e05adab008db885585acffe437c10c0bc6763e4b9e9d0f681b6283a812/adr-tools-python-0.0.11.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "0ef2518ab630feaa277587e97f2c00c3", "sha256": "2b6a592e66e2df3f57aba634de0aaf7982a10518b60a52c7122cfcce49a27fc1" }, "downloads": -1, "filename": "adr_tools_python-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0ef2518ab630feaa277587e97f2c00c3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 15402, "upload_time": "2019-06-08T22:03:01", "url": "https://files.pythonhosted.org/packages/82/f8/f184d91ee445fcc91b5c7d529bc3ea79b98143cd777cdcb0cf131c1be3bd/adr_tools_python-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a391dfb7b7d49c0a4294b7b41126c7bb", "sha256": "17646aef46d4ba27b5275b94beaac1745136c067663ba624e0fb05f742481f55" }, "downloads": -1, "filename": "adr-tools-python-1.0.tar.gz", "has_sig": false, "md5_digest": "a391dfb7b7d49c0a4294b7b41126c7bb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 7869, "upload_time": "2019-06-08T22:03:05", "url": "https://files.pythonhosted.org/packages/a5/cb/8322f4119c0a44e14c47df182e7ecabb48d50d72d0c07c4370cde3a64390/adr-tools-python-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "52fcf4e8f96bfc6e5f70a68ac68e437e", "sha256": "fbe781bd6edefa623dd57c20e0fa0a36db847b7a735442109792194bd467ca19" }, "downloads": -1, "filename": "adr_tools_python-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "52fcf4e8f96bfc6e5f70a68ac68e437e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 16488, "upload_time": "2019-06-08T22:35:30", "url": "https://files.pythonhosted.org/packages/81/94/7b6502426b84942dbb4ea1dd9808bc92f54ddefb846c98ab80e13231cde0/adr_tools_python-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cdecba4e2b5a0a29718042b8f5d1fea9", "sha256": "35b3ed3772a4829bfd9c50657f8daed56554d86bef6cd11fdd7b1c72d7fde3aa" }, "downloads": -1, "filename": "adr-tools-python-1.0.1.tar.gz", "has_sig": false, "md5_digest": "cdecba4e2b5a0a29718042b8f5d1fea9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 8789, "upload_time": "2019-06-08T22:35:31", "url": "https://files.pythonhosted.org/packages/89/24/39a4a0d5be3c436926c5489d6b6d9c96d8103c34cea673179a6653355101/adr-tools-python-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "6e3cfc6c80cc24b1cb91c2ca0711d616", "sha256": "4aafaa541f7a5afb6af7a63365d68aa9febd0e86311dbc59f2c2d96dfe0b3ca7" }, "downloads": -1, "filename": "adr_tools_python-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "6e3cfc6c80cc24b1cb91c2ca0711d616", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 16554, "upload_time": "2019-06-08T22:54:43", "url": "https://files.pythonhosted.org/packages/da/2c/9bb4252f3eb19244948baf9c45c021130ff4139aa2082fe0058d4cf85499/adr_tools_python-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "994c800dcf1822a31b14d67413052775", "sha256": "8fb74cd8ae00f05346934bc3e2413f563afd264f1dbd7089073c5c8c0708ad9d" }, "downloads": -1, "filename": "adr-tools-python-1.0.2.tar.gz", "has_sig": false, "md5_digest": "994c800dcf1822a31b14d67413052775", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 8859, "upload_time": "2019-06-08T22:54:45", "url": "https://files.pythonhosted.org/packages/98/20/d7573baaf4ff7269ab2dd7f03a4d72fc869f512bbd1d3ba4372080c4e7dc/adr-tools-python-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "11d110afd11a2a7b81ce2add3d800234", "sha256": "0bbd23ea47ec72559f16bd9e4237c1ff3ee848fd2b8a03f31e2b976ba185ecfd" }, "downloads": -1, "filename": "adr_tools_python-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "11d110afd11a2a7b81ce2add3d800234", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 12387, "upload_time": "2019-06-13T14:36:34", "url": "https://files.pythonhosted.org/packages/e8/94/a05789668094e740355318609ad176e02888a5ba637028a7b4432f1ab427/adr_tools_python-1.0.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "11d110afd11a2a7b81ce2add3d800234", "sha256": "0bbd23ea47ec72559f16bd9e4237c1ff3ee848fd2b8a03f31e2b976ba185ecfd" }, "downloads": -1, "filename": "adr_tools_python-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "11d110afd11a2a7b81ce2add3d800234", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 12387, "upload_time": "2019-06-13T14:36:34", "url": "https://files.pythonhosted.org/packages/e8/94/a05789668094e740355318609ad176e02888a5ba637028a7b4432f1ab427/adr_tools_python-1.0.3-py3-none-any.whl" } ] }