Skip to content

open-ews/gaun

Repository files navigation

gaun (गाउँ)

Build

Gaun is a Ruby library providing structured geographical and administrative data for Nepal, including provinces and districts.

गाउँ (Gaun) means village in Nepali.

This gem is designed to be lightweight, easy to use, and suitable for applications that need reliable administrative region data—such as Early Warning Systems, humanitarian platforms, civic tech, and data validation pipelines.


Features

  • 📍 Administrative geodata for Nepal
  • 🗺️ Hierarchical structure (Province → District)
  • 🧩 Easy Ruby API
  • 🚀 No external API dependencies
  • 📦 Designed for offline and embedded use
  • 🧑‍💻 Open source and extensible

Installation

Add this line to your application's Gemfile:

gem "gaun"

Then execute:

bundle install

Or install it directly:

gem install gaun

Usage

Provinces

Gaun::Province.all
province = Gaun::Province.first
province.name_en
province.name_ne

Districts

Gaun::District.all
district = Gaun::District.find { |d| d.name_en == "Bhojpur" }
district.name_en
district.name_ne

Use Cases

  • Early warning and disaster response systems
  • Address normalization and validation
  • Beneficiary management systems
  • Government and NGO platforms
  • Offline-first applications

Data Sources

The data in gaun is compiled from publicly available Government of Nepal administrative sources and verified datasets where possible.

If you find inaccuracies or updates (e.g. administrative changes), contributions are very welcome.


Development

Clone the repository and install dependencies:

git clone https://github.com/open-ews/gaun.git
cd gaun
bundle install

Run tests:

bundle exec rspec

Contributing

Contributions are welcome!

  • Bug reports
  • Data corrections
  • New administrative layers
  • Performance or API improvements

Please open an issue or submit a pull request.


License

This gem is released under the MIT License.


Related Projects

  • baan – A library containing Geodata for administrative regions in Laos
  • pumi– A library containing Geodata for administrative regions in Cambodia

About

A library containing Geodata for administrative regions in Nepal

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors