py-nepali icon indicating copy to clipboard operation
py-nepali copied to clipboard

Proposal for removing locations from py-nepali and creating a new repository for maintaining locations.

Open aj3sh opened this issue 10 months ago • 1 comments

Problem Statement

The APIs for the locations don’t seem right in this py-nepali project. Nepali locations are data, not functional code, and this data should be able to be used by any other programming language or project.

Proposed Solution

Let’s create a new repository nepali-locations. This repository will be fully responsible for maintaining the nepali locations, whether it is a typo, incorrect information, or updates from the government.

Advantages

  • Remains as a central database.
  • Can be used in multiple projects, regardless of its programming language or technology.
  • Versions can be maintained if the data gets updated.
  • The data can be served via Github pages.

Disadvantages

  • Projects cannot directly integrate with the data.
    • We will have to download the data and integrate it into their project manually
    • Or, we can use the data URL, but the cost of HTTPS requests is too high in terms of performance and time.
  • If there is any issue with the data, we will have to download the new version data and replace the existing data.

Directory Structure

|---src/
|   |---main.yaml
|
|---dist/
|   |---provinces.json
|   |---districts.json
|   |---municipalities.json
|
|---scripts/
|
|---Makefile
|---README.md
|---LICENSE

aj3sh avatar Apr 08 '24 15:04 aj3sh