classifyawsetsjsonbyregion


Nameclassifyawsetsjsonbyregion JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryClassifies AWSets JSON by region.
upload_time2023-04-17 02:53:37
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT License Copyright (c) 2023 Yukihiko Shinoda Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords classifyawsetsjsonbyregion classify-awsets-json-by-region awsets aws
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Classify AWSets JSON by Region

[![Test](https://github.com/yukihiko-shinoda/classify-awsets-json-by-region/workflows/Test/badge.svg)](https://github.com/yukihiko-shinoda/classify-awsets-json-by-region/actions?query=workflow%3ATest)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d3006b43fedc1ffd5db7/test_coverage)](https://codeclimate.com/github/yukihiko-shinoda/classify-awsets-json-by-region/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/d3006b43fedc1ffd5db7/maintainability)](https://codeclimate.com/github/yukihiko-shinoda/classify-awsets-json-by-region/maintainability)
[![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/yukihiko-shinoda/classify-awsets-json-by-region)](https://codeclimate.com/github/yukihiko-shinoda/classify-awsets-json-by-region)
[![Python versions](https://img.shields.io/pypi/pyversions/classifyawsetsjsonbyregion.svg)](https://pypi.org/project/classifyawsetsjsonbyregion)
[![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fyukihiko-shinoda%2Fclassify-awsets-json-by-region)](http://twitter.com/share?text=Classify%20AWSets%20JSON%20by%20Region&url=https://pypi.org/project/classifyawsetsjsonbyregion/&hashtags=python)

Classifies AWSets JSON by AWS region.

## Advantage

- Output the list of AWS resources as CSV files classified by AWS region
- Enable filter to exclude AWS resources not in question

### Output the list of AWS resources as CSV files classified by AWS region

You can check the states of AWS resources by AWS region. It's also useful to compare the states of AWS resources between AWS regions by using text diff tools like [Visual Studio Code].

### Enable filter to exclude AWS resources not in question

You can exclude AWS resources not in question by using `config.yml`. It's useful to reduce the number of AWS resources to be checked, such like the one AWS created by default. You can focus on AWS resources in question.

## Quickstart

1.\
Install `classifyawsetsjsonbyregion` with pip:

```console
pip install classifyawsetsjsonbyregion
```

2.\
Create following directories:

- `input`
- `output`
- `intermediate`

3.\
Put AWSets JSON files in it and rename it as `awsets.json`:

```plaintext
your_working_directory/
+---input/
    +---awsets.json
+---intermediate/
+---output/
```

4.\
Run `classify-awsets-json-by-region`:

```console
classify-awsets-json-by-region
```

<!-- markdownlint-disable no-trailing-punctuation -->
## How do I...
<!-- markdownlint-enable no-trailing-punctuation -->

<!-- markdownlint-disable no-trailing-punctuation -->
### Use intermediate directory for?
<!-- markdownlint-enable no-trailing-punctuation -->

This directory is for intermediate files. These files are useful for debugging. The contents of these files are the classifying result of AWSets JSON before filtering AWS resources. Note that the file for excluded AWS regions is not created.

## Credits

This package was created with [Cookiecutter] and the [yukihiko-shinoda/cookiecutter-pypackage] project template.

[Cookiecutter]: https://github.com/audreyr/cookiecutter
[Visual Studio Code]: https://code.visualstudio.com/
[yukihiko-shinoda/cookiecutter-pypackage]: https://github.com/audreyr/cookiecutter-pypackage

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "classifyawsetsjsonbyregion",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Yukihiko Shinoda <yuk.hik.future@gmail.com>",
    "keywords": "classifyawsetsjsonbyregion,classify-awsets-json-by-region,awsets,aws",
    "author": "",
    "author_email": "Yukihiko Shinoda <yuk.hik.future@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/25/6f/c841e6f4c2332df0559e957b34007f54836823c04843c1348e6892cb1cc2/classifyawsetsjsonbyregion-0.1.0.tar.gz",
    "platform": null,
    "description": "# Classify AWSets JSON by Region\n\n[![Test](https://github.com/yukihiko-shinoda/classify-awsets-json-by-region/workflows/Test/badge.svg)](https://github.com/yukihiko-shinoda/classify-awsets-json-by-region/actions?query=workflow%3ATest)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/d3006b43fedc1ffd5db7/test_coverage)](https://codeclimate.com/github/yukihiko-shinoda/classify-awsets-json-by-region/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/d3006b43fedc1ffd5db7/maintainability)](https://codeclimate.com/github/yukihiko-shinoda/classify-awsets-json-by-region/maintainability)\n[![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/yukihiko-shinoda/classify-awsets-json-by-region)](https://codeclimate.com/github/yukihiko-shinoda/classify-awsets-json-by-region)\n[![Python versions](https://img.shields.io/pypi/pyversions/classifyawsetsjsonbyregion.svg)](https://pypi.org/project/classifyawsetsjsonbyregion)\n[![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fyukihiko-shinoda%2Fclassify-awsets-json-by-region)](http://twitter.com/share?text=Classify%20AWSets%20JSON%20by%20Region&url=https://pypi.org/project/classifyawsetsjsonbyregion/&hashtags=python)\n\nClassifies AWSets JSON by AWS region.\n\n## Advantage\n\n- Output the list of AWS resources as CSV files classified by AWS region\n- Enable filter to exclude AWS resources not in question\n\n### Output the list of AWS resources as CSV files classified by AWS region\n\nYou can check the states of AWS resources by AWS region. It's also useful to compare the states of AWS resources between AWS regions by using text diff tools like [Visual Studio Code].\n\n### Enable filter to exclude AWS resources not in question\n\nYou can exclude AWS resources not in question by using `config.yml`. It's useful to reduce the number of AWS resources to be checked, such like the one AWS created by default. You can focus on AWS resources in question.\n\n## Quickstart\n\n1.\\\nInstall `classifyawsetsjsonbyregion` with pip:\n\n```console\npip install classifyawsetsjsonbyregion\n```\n\n2.\\\nCreate following directories:\n\n- `input`\n- `output`\n- `intermediate`\n\n3.\\\nPut AWSets JSON files in it and rename it as `awsets.json`:\n\n```plaintext\nyour_working_directory/\n+---input/\n    +---awsets.json\n+---intermediate/\n+---output/\n```\n\n4.\\\nRun `classify-awsets-json-by-region`:\n\n```console\nclassify-awsets-json-by-region\n```\n\n<!-- markdownlint-disable no-trailing-punctuation -->\n## How do I...\n<!-- markdownlint-enable no-trailing-punctuation -->\n\n<!-- markdownlint-disable no-trailing-punctuation -->\n### Use intermediate directory for?\n<!-- markdownlint-enable no-trailing-punctuation -->\n\nThis directory is for intermediate files. These files are useful for debugging. The contents of these files are the classifying result of AWSets JSON before filtering AWS resources. Note that the file for excluded AWS regions is not created.\n\n## Credits\n\nThis package was created with [Cookiecutter] and the [yukihiko-shinoda/cookiecutter-pypackage] project template.\n\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\n[Visual Studio Code]: https://code.visualstudio.com/\n[yukihiko-shinoda/cookiecutter-pypackage]: https://github.com/audreyr/cookiecutter-pypackage\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Yukihiko Shinoda  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Classifies AWSets JSON by region.",
    "version": "0.1.0",
    "split_keywords": [
        "classifyawsetsjsonbyregion",
        "classify-awsets-json-by-region",
        "awsets",
        "aws"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8292bee090d9dc0396c48ac42cba69eb602b71561dfe7914dac6343763c0facf",
                "md5": "45301bbc1a3ad9211e72fe7202e04307",
                "sha256": "d6c26f3f26b34d86f3288f3ae0c25f390711141d1a4948c76d458f2354c27da1"
            },
            "downloads": -1,
            "filename": "classifyawsetsjsonbyregion-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "45301bbc1a3ad9211e72fe7202e04307",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 9659,
            "upload_time": "2023-04-17T02:53:35",
            "upload_time_iso_8601": "2023-04-17T02:53:35.345412Z",
            "url": "https://files.pythonhosted.org/packages/82/92/bee090d9dc0396c48ac42cba69eb602b71561dfe7914dac6343763c0facf/classifyawsetsjsonbyregion-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "256fc841e6f4c2332df0559e957b34007f54836823c04843c1348e6892cb1cc2",
                "md5": "45586647e12284270ff6b4e58546465f",
                "sha256": "d7872a345c80e8583f8418278bf3ad511e43b404408c9a3a809537516d8d2b99"
            },
            "downloads": -1,
            "filename": "classifyawsetsjsonbyregion-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "45586647e12284270ff6b4e58546465f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 13091,
            "upload_time": "2023-04-17T02:53:37",
            "upload_time_iso_8601": "2023-04-17T02:53:37.221727Z",
            "url": "https://files.pythonhosted.org/packages/25/6f/c841e6f4c2332df0559e957b34007f54836823c04843c1348e6892cb1cc2/classifyawsetsjsonbyregion-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-17 02:53:37",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "classifyawsetsjsonbyregion"
}
        
Elapsed time: 0.06656s