adr_writer


Nameadr_writer JSON
Version 1.1.3 PyPI version JSON
download
home_pagehttps://gitlab.com/fer1035_python/modules/pypi-adr_writer
SummaryCreate Architecture Decision Records by answering questions to ensure consistency in formatting and thought processes.
upload_time2024-02-02 04:28:51
maintainer
docs_urlNone
authorAhmad Ferdaus Abd Razak
requires_python>=3.9,<4.0
licenseGPL-2.0-only
keywords adr writer architecture decision record
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==============
**adr_writer**
==============

Overview
--------

Create Architecture Decision Records by answering questions to ensure consistency in formatting and thought processes.

Usage
-----

Installation:

.. code-block:: BASH

    pip3 install adr_writer
    # or
    python3 -m pip install adr_writer

Bash:

.. code-block:: BASH

    python </oath/to>/adr_writer

Python:

.. code-block:: PYTHON

    import adr_writer
    adr_writer.main()

Examples
--------

- `Execution <https://github.com/fer1035/pypi-adr_writer/blob/main/examples/execution.txt>`_
- `Record output <https://github.com/fer1035/pypi-adr_writer/blob/main/examples/0012-adr-writer.md>`_

Workflow
--------

.. image:: https://raw.githubusercontent.com/fer1035/pypi-adr_writer/main/images/workflow.png
    :alt: Workflow diagram

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/fer1035_python/modules/pypi-adr_writer",
    "name": "adr_writer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "adr,writer,architecture,decision,record",
    "author": "Ahmad Ferdaus Abd Razak",
    "author_email": "ahmad.ferdaus.abd.razak@ni.com",
    "download_url": "https://files.pythonhosted.org/packages/89/97/70cf0e63b104069fd9a3d4c2fb1ac207b3bbe1dc06ae6bddae2d885cf6fe/adr_writer-1.1.3.tar.gz",
    "platform": null,
    "description": "==============\n**adr_writer**\n==============\n\nOverview\n--------\n\nCreate Architecture Decision Records by answering questions to ensure consistency in formatting and thought processes.\n\nUsage\n-----\n\nInstallation:\n\n.. code-block:: BASH\n\n    pip3 install adr_writer\n    # or\n    python3 -m pip install adr_writer\n\nBash:\n\n.. code-block:: BASH\n\n    python </oath/to>/adr_writer\n\nPython:\n\n.. code-block:: PYTHON\n\n    import adr_writer\n    adr_writer.main()\n\nExamples\n--------\n\n- `Execution <https://github.com/fer1035/pypi-adr_writer/blob/main/examples/execution.txt>`_\n- `Record output <https://github.com/fer1035/pypi-adr_writer/blob/main/examples/0012-adr-writer.md>`_\n\nWorkflow\n--------\n\n.. image:: https://raw.githubusercontent.com/fer1035/pypi-adr_writer/main/images/workflow.png\n    :alt: Workflow diagram\n",
    "bugtrack_url": null,
    "license": "GPL-2.0-only",
    "summary": "Create Architecture Decision Records by answering questions to ensure consistency in formatting and thought processes.",
    "version": "1.1.3",
    "project_urls": {
        "Homepage": "https://gitlab.com/fer1035_python/modules/pypi-adr_writer",
        "Repository": "https://gitlab.com/fer1035_python/modules/pypi-adr_writer"
    },
    "split_keywords": [
        "adr",
        "writer",
        "architecture",
        "decision",
        "record"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3784aaf3f3a9fbae43e5d01d18b9305ac925197e82bc70950aa8e0eccb4880fc",
                "md5": "314e93274d1fad4d52b92ab8a5fabf85",
                "sha256": "ca5d00b857d22020a3885e6c57249bae7b9413ffdcb6880de44ff46375659aaf"
            },
            "downloads": -1,
            "filename": "adr_writer-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "314e93274d1fad4d52b92ab8a5fabf85",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 3838,
            "upload_time": "2024-02-02T04:28:49",
            "upload_time_iso_8601": "2024-02-02T04:28:49.587926Z",
            "url": "https://files.pythonhosted.org/packages/37/84/aaf3f3a9fbae43e5d01d18b9305ac925197e82bc70950aa8e0eccb4880fc/adr_writer-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "899770cf0e63b104069fd9a3d4c2fb1ac207b3bbe1dc06ae6bddae2d885cf6fe",
                "md5": "2c719ef7c0308132ce4a52600b8b8c4b",
                "sha256": "ea1a02a73f88887e0f122decafc0d1b0ef76c718e00dab8988fad2f2634ee114"
            },
            "downloads": -1,
            "filename": "adr_writer-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2c719ef7c0308132ce4a52600b8b8c4b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 3288,
            "upload_time": "2024-02-02T04:28:51",
            "upload_time_iso_8601": "2024-02-02T04:28:51.351956Z",
            "url": "https://files.pythonhosted.org/packages/89/97/70cf0e63b104069fd9a3d4c2fb1ac207b3bbe1dc06ae6bddae2d885cf6fe/adr_writer-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-02 04:28:51",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "fer1035_python",
    "gitlab_project": "modules",
    "lcname": "adr_writer"
}
        
Elapsed time: 0.18188s