nepal-sub-divisions 0.0.1__tar.gz

nepal_sub_divisions-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dinesh Kumar Roy
+
+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.

nepal_sub_divisions-0.0.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include src/data/data.*json
+include src/nepali_municipalities

nepal_sub_divisions-0.0.1/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: nepal-sub-divisions
+Version: 0.0.1
+Summary: Nepali  municipalities is a python package to get data about Nepali municipalities based on districts
+Home-page: https://github.com/iDineshRoy/nepal-sub-divisions
+Author: Dinesh Roy
+Author-email: dinesh.roy@hotmail.com
+Keywords: Nepali,nepal,nepal provinces,nepali districts,nepali municipalities,dinesh roy,nepali states
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Nepali Municipalities
+[![Downloads](https://static.pepy.tech/personalized-badge/nepal-sub-divisions?period=total&units=international_system&left_color=black&right_color=yellowgreen&left_text=Downloads)](https://pepy.tech/project/nepal-sub-divisions)
+
+
+This is a simple and small python package contributed by me to get all list of municipalities of Nepal based on given districts of Nepal on latest version now you can autocomplete other info when municipalities name is given.
+
+# Contents
+Installation
+Use the package manager pip to install nepal-sub-divisions.
+
+
+To Autocomplete all info based on municipalities name provided
+for example if you provide municipalities names then rest of district and province will be autocompleted.
+
+```python
+from nepal_municipalities import NepalMunicipality
+
+print(NepalMunicipality.all_data_info('Kathmandu'))
+[{'province': 'Province 3', 'country': 'Nepal', 'id': 311, 'district': 'Kathmandu', 'name': 'Kathmandu'}]
+```
+
+**If No matching municipalities are supplied The Exception is thrown as below**
+``` python
+No matching info for provided municipalities try changing spelling or try another name.
+```
+
+
+
+**To get list of all districts of Nepal**
+
+```python
+from nepali_municipalities import NepalMunicipality
+
+print(NepalMunicipality.all_districts()) # this will also give the same result
+# ['Bhojpur', 'Dhankuta', 'Ilam', 'Jhapa', ......]
+
+print(NepalMunicipality.all_districts("Koshi")) # search by province name
+# ['Morang', 'Sankhuwasabha', 'Udayapur', 'Jhapa', ......]
+
+```
+
+To get list of all municipalities of Nepal based on District provided.
+
+```python
+from nepali_municipalities import NepalMunicipality
+
+print(NepalMunicipality.municipalities('Kathmandu'))
+
+# ['Kathmandu', 'Kageshwori Manohara', 'Kirtipur', 'Gokarneshwor', 'Chandragiri', 'Tokha', 'Tarkeshwor', 'Dakchinkali', 'Nagarjun', 'Budhanilkantha', 'Shankharapur']
+
+```
+
+
+# Contributing
+PRs are welcomed. Please, let me know if you have any suggestions or find any bugs.
+
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

nepal_sub_divisions-0.0.1/README.md

@@ -0,0 +1,59 @@
+# Nepali Municipalities
+[![Downloads](https://static.pepy.tech/personalized-badge/nepal-sub-divisions?period=total&units=international_system&left_color=black&right_color=yellowgreen&left_text=Downloads)](https://pepy.tech/project/nepal-sub-divisions)
+
+
+This is a simple and small python package contributed by me to get all list of municipalities of Nepal based on given districts of Nepal on latest version now you can autocomplete other info when municipalities name is given.
+
+# Contents
+Installation
+Use the package manager pip to install nepal-sub-divisions.
+
+
+To Autocomplete all info based on municipalities name provided
+for example if you provide municipalities names then rest of district and province will be autocompleted.
+
+```python
+from nepal_municipalities import NepalMunicipality
+
+print(NepalMunicipality.all_data_info('Kathmandu'))
+[{'province': 'Province 3', 'country': 'Nepal', 'id': 311, 'district': 'Kathmandu', 'name': 'Kathmandu'}]
+```
+
+**If No matching municipalities are supplied The Exception is thrown as below**
+``` python
+No matching info for provided municipalities try changing spelling or try another name.
+```
+
+
+
+**To get list of all districts of Nepal**
+
+```python
+from nepali_municipalities import NepalMunicipality
+
+print(NepalMunicipality.all_districts()) # this will also give the same result
+# ['Bhojpur', 'Dhankuta', 'Ilam', 'Jhapa', ......]
+
+print(NepalMunicipality.all_districts("Koshi")) # search by province name
+# ['Morang', 'Sankhuwasabha', 'Udayapur', 'Jhapa', ......]
+
+```
+
+To get list of all municipalities of Nepal based on District provided.
+
+```python
+from nepali_municipalities import NepalMunicipality
+
+print(NepalMunicipality.municipalities('Kathmandu'))
+
+# ['Kathmandu', 'Kageshwori Manohara', 'Kirtipur', 'Gokarneshwor', 'Chandragiri', 'Tokha', 'Tarkeshwor', 'Dakchinkali', 'Nagarjun', 'Budhanilkantha', 'Shankharapur']
+
+```
+
+
+# Contributing
+PRs are welcomed. Please, let me know if you have any suggestions or find any bugs.
+
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

nepal_sub_divisions-0.0.1/nepal_municipalities/__init__.py

@@ -0,0 +1 @@
+from .nepali_municipalities import *

nepal_sub_divisions-0.0.1/nepal_municipalities/nepal_municipalities.py

@@ -0,0 +1,141 @@
+import json
+import os
+from typing import Dict
+
+
+class DistrictNotFoundException(Exception):
+    """Exception to be raised if correct district is not provided by user"""
+
+    pass
+
+
+class DistrictNotProvidedException(Exception):
+    """Exception to be raised if district is not provided by user"""
+
+    pass
+
+
+class MunicipalityNotFoundException(Exception):
+    """Exception to be raised if municipality is not found"""
+
+    pass
+
+
+class NepalMunicipality:
+    BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+    DATA_PATH = os.path.join(BASE_DIR, "data", "data.json")
+    ALL_MUNICIPALITIES_PATH = os.path.join(
+        BASE_DIR, "data", "all_nepali_municipalities.json"
+    )
+
+    def __init__(self, district_name: str = None):
+        self.municipality_name = None
+        self._district_name = district_name
+        self._data = self._load_json(self.DATA_PATH)
+
+    @staticmethod
+    def _load_json(file_path: str) -> list[Dict]:
+        with open(file_path, "r") as f:
+            return json.load(f)
+
+    def all_municipalities(self):
+        """
+        Use this to get list of all municipalities of specific district
+        provided from class instance if district is none You will get None as return Value
+        """
+        if self._district_name is not None:
+            for items in self._data:
+                if self._district_name in self.all_districts():
+                    if items.get(self._district_name) is not None:
+                        return items.get(self._district_name)
+                else:
+                    raise DistrictNotFoundException(
+                        "District not found for following text, please check "
+                        "district spelling."
+                    )
+        raise DistrictNotProvidedException(
+            "District not provided please provide district name."
+        )
+
+    @classmethod
+    def municipalities(cls, district_name: str = None):
+        """
+        Use this method to get a list of all municipalities in a specific district.
+        :param district_name: The name of the district. If None, use the instance's district name.
+        :return: A list of municipalities in the specified district.
+        """
+        # Check if this is an instance method call
+        if not isinstance(cls, type):
+            # This is an instance method call
+            district_name = district_name or cls._district_name
+
+        # If district_name is still None, raise the exception
+        if district_name is None:
+            raise DistrictNotProvidedException(
+                "District not provided. Please provide a district name."
+            )
+
+        data = cls._load_json(cls.DATA_PATH)
+        districts = cls.all_districts()
+
+        if district_name not in districts:
+            raise DistrictNotFoundException(
+                f"District '{district_name}' not found. Please check the spelling."
+            )
+
+        for item in data:
+            if district_name in item:
+                return item[district_name]
+
+        raise DistrictNotFoundException(
+            f"Municipalities for district '{district_name}' could not be found."
+        )
+
+    @classmethod
+    def all_districts(cls, province_name: str = None) -> list[str]:
+        """Use this method to get a list of all districts of Nepal."""
+        data = cls._load_json(cls.DATA_PATH)
+        muni_data = cls._load_json(cls.ALL_MUNICIPALITIES_PATH)
+        all_districts: list = [list(item.keys())[0] for item in data]
+        if province_name:
+            filtered_entries = [e for e in muni_data if e["province"] == province_name]
+            all_districts = list(set([entry["district"] for entry in filtered_entries]))
+        return all_districts
+
+    @classmethod
+    def all_data_info(cls, municipality_name: str = None) -> Dict[str, str]:
+        """
+        Use this method to get the details of a specific municipality, such as its district, province, and province number.
+        :param municipality_name: The name of the municipality.
+        :return: A dictionary with details about the municipality.
+        """
+        data = cls._load_json(cls.ALL_MUNICIPALITIES_PATH)
+
+        province_mapping = {
+            "Koshi": "Province 1",
+            "Madhesh": "Province 2",
+            "Bagmati": "Province 3",
+            "Gandaki": "Province 4",
+            "Lumbini": "Province 5",
+            "Karnali": "Province 6",
+            "Sudurpashchim": "Province 7",
+        }
+
+        for item in data:
+            if item["name"].lower() == municipality_name.lower():
+                return {
+                    "municipality": item["name"],
+                    "district": item["district"],
+                    "province": item["province"],
+                    "province_no": province_mapping.get(item["province"], "Unknown"),
+                    "country": item["country"],
+                }
+
+        raise MunicipalityNotFoundException(
+            f"No matching info for provided municipality '{municipality_name}'. "
+            "Please check the spelling or try another name."
+        )
+
+
+if __name__ == "__main__":
+    print(NepalMunicipality.all_data_info("Kathmandu"))

nepal_sub_divisions-0.0.1/nepal_municipalities/test.py

@@ -0,0 +1,4 @@
+from nepal_municipalities import NepalMunicipality
+
+district = NepalMunicipality.all_municipalities("Kaski")
+print(district)

nepal_sub_divisions-0.0.1/nepal_sub_divisions.egg-info/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: nepal-sub-divisions
+Version: 0.0.1
+Summary: Nepali  municipalities is a python package to get data about Nepali municipalities based on districts
+Home-page: https://github.com/iDineshRoy/nepal-sub-divisions
+Author: Dinesh Roy
+Author-email: dinesh.roy@hotmail.com
+Keywords: Nepali,nepal,nepal provinces,nepali districts,nepali municipalities,dinesh roy,nepali states
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Nepali Municipalities
+[![Downloads](https://static.pepy.tech/personalized-badge/nepal-sub-divisions?period=total&units=international_system&left_color=black&right_color=yellowgreen&left_text=Downloads)](https://pepy.tech/project/nepal-sub-divisions)
+
+
+This is a simple and small python package contributed by me to get all list of municipalities of Nepal based on given districts of Nepal on latest version now you can autocomplete other info when municipalities name is given.
+
+# Contents
+Installation
+Use the package manager pip to install nepal-sub-divisions.
+
+
+To Autocomplete all info based on municipalities name provided
+for example if you provide municipalities names then rest of district and province will be autocompleted.
+
+```python
+from nepal_municipalities import NepalMunicipality
+
+print(NepalMunicipality.all_data_info('Kathmandu'))
+[{'province': 'Province 3', 'country': 'Nepal', 'id': 311, 'district': 'Kathmandu', 'name': 'Kathmandu'}]
+```
+
+**If No matching municipalities are supplied The Exception is thrown as below**
+``` python
+No matching info for provided municipalities try changing spelling or try another name.
+```
+
+
+
+**To get list of all districts of Nepal**
+
+```python
+from nepali_municipalities import NepalMunicipality
+
+print(NepalMunicipality.all_districts()) # this will also give the same result
+# ['Bhojpur', 'Dhankuta', 'Ilam', 'Jhapa', ......]
+
+print(NepalMunicipality.all_districts("Koshi")) # search by province name
+# ['Morang', 'Sankhuwasabha', 'Udayapur', 'Jhapa', ......]
+
+```
+
+To get list of all municipalities of Nepal based on District provided.
+
+```python
+from nepali_municipalities import NepalMunicipality
+
+print(NepalMunicipality.municipalities('Kathmandu'))
+
+# ['Kathmandu', 'Kageshwori Manohara', 'Kirtipur', 'Gokarneshwor', 'Chandragiri', 'Tokha', 'Tarkeshwor', 'Dakchinkali', 'Nagarjun', 'Budhanilkantha', 'Shankharapur']
+
+```
+
+
+# Contributing
+PRs are welcomed. Please, let me know if you have any suggestions or find any bugs.
+
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

nepal_sub_divisions-0.0.1/nepal_sub_divisions.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+MANIFEST.in
+README.md
+setup.py
+nepal_municipalities/__init__.py
+nepal_municipalities/nepal_municipalities.py
+nepal_municipalities/test.py
+nepal_municipalities/data/__init__.py
+nepal_sub_divisions.egg-info/PKG-INFO
+nepal_sub_divisions.egg-info/SOURCES.txt
+nepal_sub_divisions.egg-info/dependency_links.txt
+nepal_sub_divisions.egg-info/top_level.txt

nepal_sub_divisions-0.0.1/nepal_sub_divisions.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

nepal_sub_divisions-0.0.1/nepal_sub_divisions.egg-info/top_level.txt

@@ -0,0 +1 @@
+nepal_municipalities

nepal_sub_divisions-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

nepal_sub_divisions-0.0.1/setup.py

@@ -0,0 +1,33 @@
+import setuptools as setuptools
+from setuptools import setup
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setup(
+    name="nepal-sub-divisions",
+    version="0.0.1",  # Required
+    description="Nepali  municipalities is a python package to get data about Nepali municipalities based on districts",
+    url="https://github.com/iDineshRoy/nepal-sub-divisions",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Dinesh Roy",
+    author_email="dinesh.roy@hotmail.com",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.6",
+    include_package_data=True,
+    keywords=[
+        "Nepali",
+        "nepal",
+        "nepal provinces",
+        "nepali districts",
+        "nepali municipalities",
+        "dinesh roy",
+        "nepali states",
+    ],
+)