katottglib 0.1.0__tar.gz

katottglib-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Denis Senchishen
+
+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.

katottglib-0.1.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: katottglib
+Version: 0.1.0
+Summary: A Python lib to operate KATOTTG addresses (classified administrative division of Ukraine).
+Home-page: https://github.com/sen-den/katottglib
+Author: Denis Senchishen
+Author-email: dsenchishen@icloud.com
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+
+===========
+KATOTTG lib
+===========
+
+Quick start
+-----------
+
+To be done...
+
+Release notes
+-------------
+
+v0.1.0 (2023-06-10)
+...................
+
+Initial release.
+
+- Search by name with filter by level (``find_by_name``).
+- Search by identifier (``find_by_id``)

katottglib-0.1.0/README.rst

@@ -0,0 +1,19 @@
+===========
+KATOTTG lib
+===========
+
+Quick start
+-----------
+
+To be done...
+
+Release notes
+-------------
+
+v0.1.0 (2023-06-10)
+...................
+
+Initial release.
+
+- Search by name with filter by level (``find_by_name``).
+- Search by identifier (``find_by_id``)

katottglib-0.1.0/data/__init__.py

@@ -0,0 +1,3 @@
+from .data import load_data
+
+__all__ = ["load_data"]

katottglib-0.1.0/data/data.py

@@ -0,0 +1,37 @@
+import os
+
+import pandas as pd
+
+
+def load_xlsx() -> pd.DataFrame:
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    file_path = os.path.join(script_dir, "kodifikator.xlsx")
+    df = pd.read_excel(file_path, skiprows=2, skipfooter=3)
+    return df
+
+
+def load_data() -> pd.DataFrame:
+    df = load_xlsx()
+    df["id"] = df["Додатковий рівень"].fillna(
+        df["Четвертий рівень"].fillna(
+            df["Третій рівень"].fillna(
+                df["Другий рівень"].fillna(df["Перший рівень"])
+            )
+        )
+    )
+    category_mapping = {
+        "O": "Області та АРК",
+        "K": "Міста зі спеціальним статусом (Київ та Севастополь)",
+        "P": "Райони в областях та в АРК",
+        "H": "Територіальні громади",
+        "M": "Міста",
+        "T": "Селища міського типу",
+        "C": "Села",
+        "X": "Селища",
+        "B": "Райони в містах",
+    }
+
+    df["Назва категорії об’єкта"] = df["Категорія об’єкта"].map(
+        category_mapping
+    )
+    return df

katottglib-0.1.0/data/entity.py

@@ -0,0 +1,18 @@
+class KatottgEntity:
+    def __init__(self, entity_id, name, category, parent=None):
+        self.entity_id = entity_id
+        self.name = name
+        self.category = category
+        self.parent = parent
+
+    def add_parent(self, parent):
+        if self.parent is None:
+            self.parent = parent
+        else:
+            self.parent.add_parent(parent)
+
+    def __str__(self, indent=""):
+        output = f"{indent}{self.category} - {self.name} [{self.entity_id}]"
+        if self.parent:
+            output += "\n" + self.parent.__str__(indent + "\t")
+        return output

katottglib-0.1.0/katottglib.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: katottglib
+Version: 0.1.0
+Summary: A Python lib to operate KATOTTG addresses (classified administrative division of Ukraine).
+Home-page: https://github.com/sen-den/katottglib
+Author: Denis Senchishen
+Author-email: dsenchishen@icloud.com
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+
+===========
+KATOTTG lib
+===========
+
+Quick start
+-----------
+
+To be done...
+
+Release notes
+-------------
+
+v0.1.0 (2023-06-10)
+...................
+
+Initial release.
+
+- Search by name with filter by level (``find_by_name``).
+- Search by identifier (``find_by_id``)

katottglib-0.1.0/katottglib.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.rst
+pyproject.toml
+setup.cfg
+setup.py
+data/__init__.py
+data/data.py
+data/entity.py
+katottglib.egg-info/PKG-INFO
+katottglib.egg-info/SOURCES.txt
+katottglib.egg-info/dependency_links.txt
+katottglib.egg-info/top_level.txt
+test/__init__.py

katottglib-0.1.0/katottglib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

katottglib-0.1.0/katottglib.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+data
+test

katottglib-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.black]
+line-length = 80
+multi_line_output = 3
+include-trailing-comma = true
+target-version = ['py311']
+extend-exclude = '''
+/(
+    \.git
+  | \.github
+  | \.idea
+  | \.venv
+)/
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 80
+force_sort_within_sections = true
+atomic = true
+
+[tool.mypy]
+python_version = "3.11"
+show_error_codes = true
+warn_return_any = false
+pretty = true
+follow_imports = 'silent'

katottglib-0.1.0/setup.cfg

@@ -0,0 +1,25 @@
+[metadata]
+name = katottglib
+version = 0.1.0
+description = A Python lib to operate KATOTTG addresses (classified administrative division of Ukraine).
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+url = https://github.com/sen-den/katottglib
+author = Denis Senchishen
+author_email = dsenchishen@icloud.com
+license = MIT
+classifiers = 
+	Intended Audience :: Developers
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+
+[options]
+include_package_data = true
+packages = find:
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

katottglib-0.1.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

katottglib-0.1.0/test/__init__.py

@@ -0,0 +1,41 @@
+import unittest
+
+import katottg
+
+
+class KatottgSearchTestCase(unittest.TestCase):
+    def test_simple_search(self):
+        cases = (
+            ("Херсон", "UA65100150010064384"),
+            ("Миколаїв", "UA46100110010094231"),
+            ("Миколаївка", "UA05100090120011921"),
+            ("Червона Поляна", "UA05100110150052879"),
+        )
+        for input_query, expected_id in cases:
+            actual = katottg.find_by_name(input_query)
+            self.assertTrue(len(actual) > 0)
+            self.assertEqual(expected_id, actual[0].entity_id)
+
+    def test_search_in_parent(self):
+        cases = (
+            ("Червона Поляна", "UA65000000000030969", "UA65060130090033121"),  # В Херсонській області
+            ("Червона Поляна", "UA35000000000016081", "UA35060090140077182"),  # В Кіровоградській області
+        )
+        for input_query, parent_id, expected_id in cases:
+            actual = katottg.find_by_name(input_query, parent_id=parent_id)
+            self.assertTrue(len(actual) > 0)
+            self.assertEqual(expected_id, actual[0].entity_id)
+
+    def test_search_with_limit(self):
+        self.assertEqual(len(katottg.find_by_name("Червона Поляна")), 5)
+        self.assertEqual(len(katottg.find_by_name("Червона Поляна", limit=5)), 5)
+        self.assertEqual(len(katottg.find_by_name("Червона Поляна", limit=100)), 100)  # No similarity threshold yet!
+
+    def test_find_by_id(self):
+        self.assertEqual(katottg.find_by_id("UA65060130090033121").name, "Червона Поляна")
+        self.assertEqual(katottg.find_by_id("UA65100150010064384").name, "Херсон")
+        self.assertEqual(katottg.find_by_id("UA00000001234567890"), None)
+
+
+if __name__ == '__main__':
+    unittest.main()