tfanalyse

Name	tfanalyse JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	Lightweight command-line utility to analyse Terraform plan files
upload_time	2024-07-15 11:25:55
maintainer	None
docs_url	None
author	Tobias Waslowski
requires_python	<4.0,>=3.10
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ![Build](https://github.com/twaslowski/tfanalyse/actions/workflows/test.yml/badge.svg)
![Coverage](./test/coverage.svg)

# tfanalyse

tfanalyse is a lightweight command-line utility to summarise the contents of a Terraform plan.
It allows you to quickly see what resources are being created, updated, or destroyed, and what changes are being made to them.

## Installation

You can install this tool using pip:

```bash
pip install tfanalyse
```

You can also install it from source:

```bash
git clone git@github.com:twaslowski/tfanalyse.git
pip install ./tfanalyse/   # global installation
poetry install  # local installation
```

## Usage

To use the tool, simply run it with the path to the Terraform plan file as an argument:

```
terraform plan -out=plan.tfplan
tfanalyse summarise plan.tfplan
```

This will output a summary of the plan, showing the resources that are being created, updated, or destroyed.
You can list only the resources that would be destroyed by adding the `--destroy-only` flag.

## Development

This is a very minimal tool for now. I will develop it to be useful for me, and I hope that others may find it useful
too. If you would like to develop it further, feel free to fork the repository and submit a pull request.

You can set up the local development environment using [Poetry](https://python-poetry.org/): Simply run `poetry install`.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tfanalyse",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Tobias Waslowski",
    "author_email": "tobiaswaslowski@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bf/86/03def7e6314563f096d4ede606e8680eebf15870f11b144f06337e7e0d90/tfanalyse-0.2.0.tar.gz",
    "platform": null,
    "description": "![Build](https://github.com/twaslowski/tfanalyse/actions/workflows/test.yml/badge.svg)\n![Coverage](./test/coverage.svg)\n\n# tfanalyse\n\ntfanalyse is a lightweight command-line utility to summarise the contents of a Terraform plan.\nIt allows you to quickly see what resources are being created, updated, or destroyed, and what changes are being made to them.\n\n## Installation\n\nYou can install this tool using pip:\n\n```bash\npip install tfanalyse\n```\n\nYou can also install it from source:\n\n```bash\ngit clone git@github.com:twaslowski/tfanalyse.git\npip install ./tfanalyse/   # global installation\npoetry install  # local installation\n```\n\n## Usage\n\nTo use the tool, simply run it with the path to the Terraform plan file as an argument:\n\n```\nterraform plan -out=plan.tfplan\ntfanalyse summarise plan.tfplan\n```\n\nThis will output a summary of the plan, showing the resources that are being created, updated, or destroyed.\nYou can list only the resources that would be destroyed by adding the `--destroy-only` flag.\n\n## Development\n\nThis is a very minimal tool for now. I will develop it to be useful for me, and I hope that others may find it useful\ntoo. If you would like to develop it further, feel free to fork the repository and submit a pull request.\n\nYou can set up the local development environment using [Poetry](https://python-poetry.org/): Simply run `poetry install`.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Lightweight command-line utility to analyse Terraform plan files",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "767630dc9c5977c8d5c86625ba5d857fcf38b240b56a1c234c52776a5da5ea26",
                "md5": "c7f5775f4825f7c14435ae18a4939589",
                "sha256": "d7bd3cbb581977f33078844210dbcfc0fa065efef43088fb55d3728a6242fcaa"
            },
            "downloads": -1,
            "filename": "tfanalyse-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c7f5775f4825f7c14435ae18a4939589",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 5086,
            "upload_time": "2024-07-15T11:25:54",
            "upload_time_iso_8601": "2024-07-15T11:25:54.294048Z",
            "url": "https://files.pythonhosted.org/packages/76/76/30dc9c5977c8d5c86625ba5d857fcf38b240b56a1c234c52776a5da5ea26/tfanalyse-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf8603def7e6314563f096d4ede606e8680eebf15870f11b144f06337e7e0d90",
                "md5": "0727a8ccb34e7e3065bf6dae6d367597",
                "sha256": "d4289b07d46e781e1558a2f28a503b163edcbc28c7f57d54926b78dae4064ad4"
            },
            "downloads": -1,
            "filename": "tfanalyse-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0727a8ccb34e7e3065bf6dae6d367597",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 3889,
            "upload_time": "2024-07-15T11:25:55",
            "upload_time_iso_8601": "2024-07-15T11:25:55.471828Z",
            "url": "https://files.pythonhosted.org/packages/bf/86/03def7e6314563f096d4ede606e8680eebf15870f11b144f06337e7e0d90/tfanalyse-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-15 11:25:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "tfanalyse"
}