classifyawsetsjsonbyregion 0.1.0__py3-none-any.whl

classifyawsetsjsonbyregion/__init__.py

@@ -0,0 +1,5 @@
+"""Top-level package for Classify AWSets JSON by Region."""
+
+__author__ = """Yukihiko Shinoda"""
+__email__ = "yuk.hik.future@gmail.com"
+__version__ = "0.1.0"

classifyawsetsjsonbyregion/analyzer.py

@@ -0,0 +1,46 @@
+"""Analyze AWSets JSON."""
+from __future__ import annotations
+
+import json
+from typing import Any
+
+from classifyawsetsjsonbyregion.awsets import Awset, AwsetFilter
+from classifyawsetsjsonbyregion.awsregion.classifier import Classifier
+from classifyawsetsjsonbyregion.config import Config
+from classifyawsetsjsonbyregion.csv import OutputCsv
+from classifyawsetsjsonbyregion.filepath import FilePathCreator
+
+CONFIG: Config = Config()
+
+
+class AwsetsJsonAnalyzer:
+    """To analyze AWSets JSON."""
+
+    UTF8 = "utf-8"
+
+    def __init__(self) -> None:
+        CONFIG.load("config.yml")
+        self.file_path_creator = FilePathCreator()
+        self.classifier = Classifier(CONFIG.region_exclude)
+        self.awset_filter = AwsetFilter(CONFIG.ignore_pattern)
+
+    def analyze(self) -> None:
+        awsets = json.loads(self.file_path_creator.path_resources_json.read_text(encoding=self.UTF8))
+        awsets = [awset for awset in awsets if awset["Region"] not in CONFIG.region_exclude]
+        self.file_path_creator.file_awsets_other_regions.write_text(json.dumps(awsets, indent=2), encoding=self.UTF8)
+        for region_name, awsets_in_region in self.classifier.classify_by_region(awsets).items():
+            self.analyze_each_region(region_name, awsets_in_region)
+
+    def analyze_each_region(self, region_name: str, awsets: list[Awset]) -> None:
+        """Analyzes AWSets in each region."""
+        sorted_awsets = sorted(awsets, key=lambda x: (x["Type"], x["Name"], x["Tags"]))
+        path_json = self.file_path_creator.create_path_json_per_region(region_name)
+        path_json.write_text(json.dumps(sorted_awsets, indent=2), encoding=self.UTF8)
+        output_csv = OutputCsv(self.file_path_creator.create_path_csv_per_region(region_name))
+        with output_csv.writer() as writer:
+            # Reason: Return values are None. pylint: disable=expression-not-assigned
+            [writer.writerow(self.to_row(awset)) for awset in sorted_awsets if self.awset_filter.is_passed(awset)]
+
+    @staticmethod
+    def to_row(awset: Awset) -> list[Any]:
+        return [awset["Type"], awset["Name"], awset["Tags"]]

classifyawsetsjsonbyregion/awsets.py

@@ -0,0 +1,39 @@
+"""Model of AWSets."""
+from __future__ import annotations
+
+import re
+import sys
+
+if sys.version_info >= (3, 8):
+    from typing import TypedDict
+else:
+    from typing_extensions import TypedDict  # pragma: no cover
+
+
+class Awset(TypedDict):
+    Region: str
+    Type: str
+    Name: str
+    Tags: dict[str, str]
+
+
+class AwsetFilter:
+    """To filter AWSets data for specific investigation purpose."""
+
+    def __init__(self, dict_ignore_pattern: dict[str, list[str]]) -> None:
+        self.dict_ignore_pattern = dict_ignore_pattern
+
+    def is_passed(self, awset: Awset) -> bool:
+        """Filter AWSets data.
+
+        Args:
+            awset: AWSets data of target resource
+        Returns:
+            True: Target resource should be filtered
+            False: Target resource should not be filtered
+        """
+        list_ignore_pattern = self.dict_ignore_pattern.get(awset["Type"])
+        if not list_ignore_pattern:
+            return True
+        regex = "|".join(list_ignore_pattern)
+        return not re.search(regex, awset["Name"])

classifyawsetsjsonbyregion/awsregion/__init__.py

@@ -0,0 +1 @@
+"""AWS region."""

classifyawsetsjsonbyregion/awsregion/classifier.py

@@ -0,0 +1,51 @@
+"""Classifies AWSets into each regions."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from classifyawsetsjsonbyregion.awsets import Awset
+
+
+REGIONS = {
+    "us-east-1": "US East (N. Virginia)",
+    "us-east-2": "US East (Ohio)",
+    "us-west-1": "US West (N. California)",
+    "us-west-2": "US West (Oregon)",
+    "ap-south-1": "Asia Pacific (Mumbai)",
+    "ap-northeast-3": "Asia Pacific (Osaka)",
+    "ap-northeast-2": "Asia Pacific (Seoul)",
+    "ap-southeast-1": "Asia Pacific (Singapore)",
+    "ap-southeast-2": "Asia Pacific (Sydney)",
+    "ap-northeast-1": "Asia Pacific (Tokyo)",
+    "ca-central-1": "Canada (Central)",
+    "eu-central-1": "Europe (Frankfurt)",
+    "eu-west-1": "Europe (Ireland)",
+    "eu-west-2": "Europe (London)",
+    "eu-west-3": "Europe (Paris)",
+    "eu-north-1": "Europe (Stockholm)",
+    "sa-east-1": "South America (São Paulo)",
+    "aws-global": "global",
+}
+
+
+def create_classified_awsets_empty(regions_exclude: list[str]) -> dict[str, list[Awset]]:
+    classified_awsets_empty: dict[str, list[Awset]] = {}
+    for region_name in REGIONS:
+        if region_name in regions_exclude:
+            continue
+        classified_awsets_empty[region_name] = []
+    return classified_awsets_empty
+
+
+class Classifier:
+    """To report in each region."""
+
+    def __init__(self, region_exclude: list[str]) -> None:
+        self.classified_awsets = create_classified_awsets_empty(region_exclude)
+
+    def classify_by_region(self, awsets: list[Awset]) -> dict[str, list[Awset]]:
+        for awset in awsets:
+            region = awset["Region"]
+            self.classified_awsets[region].append(awset)
+        return self.classified_awsets

classifyawsetsjsonbyregion/cli.py

@@ -0,0 +1,17 @@
+"""Console script for classifyawsetsjsonbyregion."""
+import sys
+
+import click
+
+from classifyawsetsjsonbyregion.analyzer import AwsetsJsonAnalyzer
+
+
+@click.command()
+def main() -> int:
+    """Console script for classifyawsetsjsonbyregion."""
+    AwsetsJsonAnalyzer().analyze()
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())  # pragma: no cover

classifyawsetsjsonbyregion/config.py

@@ -0,0 +1,11 @@
+"""Configurations."""
+from dataclasses import dataclass
+from typing import Dict, List
+
+from yamldataclassconfig import YamlDataClassConfig
+
+
+@dataclass
+class Config(YamlDataClassConfig):
+    region_exclude: List[str] = None  # type: ignore[assignment]
+    ignore_pattern: Dict[str, List[str]] = None  # type: ignore[assignment]

classifyawsetsjsonbyregion/csv.py

@@ -0,0 +1,27 @@
+"""Json to CSV."""
+from contextlib import contextmanager, suppress
+import csv
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    import _csv
+
+    # Reason: For type hinting.
+    standard_csv_writer = _csv._writer  # noqa: SLF001  pylint: disable=protected-access,no-member
+
+
+class OutputCsv:
+    """To output AWSets data into CSV."""
+
+    def __init__(self, path_csv: Path) -> None:
+        self.path_csv = path_csv
+        with suppress(FileNotFoundError):
+            self.path_csv.unlink()
+
+    @contextmanager
+    def writer(self) -> "Generator[standard_csv_writer, None, None]":
+        with self.path_csv.open("w", newline="") as csv_file_pointer:
+            yield csv.writer(csv_file_pointer, delimiter=" ", quotechar="|", quoting=csv.QUOTE_MINIMAL)

classifyawsetsjsonbyregion/filepath.py

@@ -0,0 +1,21 @@
+"""JSON per each regions."""
+from pathlib import Path
+
+
+class FilePathCreator:
+    """To aggregate path to file."""
+
+    DIRECTORY_INPUT = Path("input")
+    DIRECTORY_INTERMEDIATE = Path("intermediate")
+    DIRECTORY_OUTPUT = Path("output")
+
+    def __init__(self) -> None:
+        self.path_resources_json = self.DIRECTORY_INPUT / "awsets.json"
+        output_file_name = f"{self.path_resources_json.stem}-other-regions.json"
+        self.file_awsets_other_regions = self.DIRECTORY_INTERMEDIATE / output_file_name
+
+    def create_path_json_per_region(self, regions_name: str) -> Path:
+        return self.DIRECTORY_INTERMEDIATE / f"{self.file_awsets_other_regions.stem}-{regions_name}.json"
+
+    def create_path_csv_per_region(self, region_name: str) -> Path:
+        return self.DIRECTORY_OUTPUT / f"{self.file_awsets_other_regions.stem}-{region_name}.csv"

classifyawsetsjsonbyregion-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+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.

classifyawsetsjsonbyregion-0.1.0.dist-info/METADATA

@@ -0,0 +1,133 @@
+Metadata-Version: 2.1
+Name: classifyawsetsjsonbyregion
+Version: 0.1.0
+Summary: Classifies AWSets JSON by region.
+Author-email: Yukihiko Shinoda <yuk.hik.future@gmail.com>
+Maintainer-email: Yukihiko Shinoda <yuk.hik.future@gmail.com>
+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.
+        
+Project-URL: homepage, https://github.com/yukihiko-shinoda/classify-awsets-json-by-region
+Project-URL: repository, https://github.com/yukihiko-shinoda/classify-awsets-json-by-region
+Keywords: classifyawsetsjsonbyregion,classify-awsets-json-by-region,awsets,aws
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Security
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Text Processing :: Filters
+Classifier: Typing :: Typed
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click (>=7.0)
+Requires-Dist: yamldataclassconfig
+Requires-Dist: typing-extensions ; python_version <= "3.7"
+Provides-Extra: test
+
+# 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

classifyawsetsjsonbyregion-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+classifyawsetsjsonbyregion/__init__.py,sha256=jDplQozIZ-Q3voVnqku-SwpmbB1MIHatZrwNbvAL4Dc,158
+classifyawsetsjsonbyregion/analyzer.py,sha256=EUr2ALsLpSjOEW9C0MW9chAB2lHEiGfQWKzzbZGavQk,2115
+classifyawsetsjsonbyregion/awsets.py,sha256=IMVf91hmGpr7HEaNd-93zqgQ9-CZP8d4QtxlOoL0Zs8,1045
+classifyawsetsjsonbyregion/cli.py,sha256=1TbPwcvVubuN8E2Uil7oPQ9tkleTNfwRi4Gx5IodMeY,359
+classifyawsetsjsonbyregion/config.py,sha256=BuSXdQ2FuE7aFLto8uTr4VJxhsmybIO5Pm25vuidAzA,328
+classifyawsetsjsonbyregion/csv.py,sha256=WqBObx3doUxSE9_PvGbhUOKmpR7ygM6aCGD9QXk7C7E,831
+classifyawsetsjsonbyregion/filepath.py,sha256=uX7f6ocwGsj5H94lQ6e5sXSJQhq8RLQ4D9UyHlUv4kI,859
+classifyawsetsjsonbyregion/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+classifyawsetsjsonbyregion/awsregion/__init__.py,sha256=bWKS1SwYtC4Vi8gdLzqDaFL7hzc5vgR9P0sriC6Wtig,18
+classifyawsetsjsonbyregion/awsregion/classifier.py,sha256=epUf-nyEPkMmbue9S7SXqgUBdL0NSh8a5iS4HVfdC_4,1713
+classifyawsetsjsonbyregion-0.1.0.dist-info/LICENSE,sha256=NiIdqgTwrHZWOeTg5VvcrBrgM1t1juwgA3G2QjSrj1k,1073
+classifyawsetsjsonbyregion-0.1.0.dist-info/METADATA,sha256=UeS8dSrQSz-ct94JBr-zmL5blR-a-BKUZPWUWuMkdHA,6131
+classifyawsetsjsonbyregion-0.1.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+classifyawsetsjsonbyregion-0.1.0.dist-info/entry_points.txt,sha256=reGLUm0s5HqhUIYLseszDqxqmAxpu4xHJCKoFPKU0GE,87
+classifyawsetsjsonbyregion-0.1.0.dist-info/top_level.txt,sha256=PlOuOCJMhrrbkQ4vFG7utFaWef-LipkyZ_q3Go8JIyA,27
+classifyawsetsjsonbyregion-0.1.0.dist-info/RECORD,,

classifyawsetsjsonbyregion-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.40.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

classifyawsetsjsonbyregion-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+classify-awsets-json-by-region = classifyawsetsjsonbyregion.cli:main

classifyawsetsjsonbyregion-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+classifyawsetsjsonbyregion