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

[aj3sh]

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

[sugat009]

The most practical approach for distributing the data in this case would be to provide downloadable .json files(possibly as releases), rather than having an actual API endpoint that serves the data.