https://github.com/kusaasira/uganda-geo-data
Uganda's geo data i.e districts, counties, subcounties, parishes & villages.
https://github.com/kusaasira/uganda-geo-data
districts-in-uganda districts-uganda hacktoberfest hacktoberfest2022 uganda
Last synced: 6 months ago
JSON representation
Uganda's geo data i.e districts, counties, subcounties, parishes & villages.
- Host: GitHub
- URL: https://github.com/kusaasira/uganda-geo-data
- Owner: kusaasira
- License: mit
- Created: 2022-04-24T19:14:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-18T15:37:55.000Z (over 2 years ago)
- Last Synced: 2026-01-14T14:49:29.148Z (6 months ago)
- Topics: districts-in-uganda, districts-uganda, hacktoberfest, hacktoberfest2022, uganda
- Language: PHP
- Homepage: https://packagist.org/packages/kusaasira/uganda-geo
- Size: 803 KB
- Stars: 10
- Watchers: 3
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Uganda Geo Data
This is a PHP package that retrieves Uganda's districts with their respective counties, sub counties, parishes and villages in Uganda. This data has been scrapped off [Uganda's passport's official portal](https://passports.go.ug).
# Description
This package gives you the leverage to access all sub levels ranging from districts, counties, subcounties, parishes to villages in Uganda. You can also access the different mentioned areas independently.
## Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Retrieve Districts data](#retrieve-districts-data)
- [Retrieve Individual geo units data.](#retrieve-individual-geo-units-data)
- [Credits](#credits)
- [Contributions](#contributions)
- [License](#license)
## Requirements
In order to run this project, ensure that you have installed;
- PHP 7.4 or later
- Composer
## Installation
This project using composer.
```
$ composer require kusaasira/uganda-geo
```
## Usage
The examples below show examples of usage of the package and their resulting outputs
### Retrieve Districts data.
```php
use Uganda\Uganda;
$uganda = new Uganda();
# Retrieve all districts
$districts = $uganda->districts();
# Retrieve all counties in a particular district
$counties = $uganda
->district('Mukono')
->counties();
# Retrieve all sub counties in a particular district
$subCounties = $uganda
->district('Mukono')
->subCounties();
# Retrieve all parishes in a particular district
$parishes = $uganda
->district('Mukono')
->parishes();
# Retrieve all villages in a particular district
$villages = $uganda
->district('Mukono')
->villages();
```
### Retrieve County data.
```php
use Uganda\Uganda;
$uganda = new Uganda();
# Retrieve all counties
$counties = $uganda->counties();
# Retrieve specific county
$county = $uganda->county('Adjumani West County');
# Retrieve all sub counties in a particular county
$subCounties = $uganda
->county('Adjumani West County')
->subCounties();
# Retrieve all parishes in a particular county
$parishes = $uganda
->county('Adjumani West County')
->parishes();
# Retrieve all villages in a particular county
$villages = $uganda
->county('Adjumani West County')
->villages();
```
### Retrieve Sub County data.
```php
use Uganda\Uganda;
$uganda = new Uganda();
# Retrieve all sub counties
$subCounties = $uganda->subCounties();
# Retrieve specific sub county
$subCounty = $uganda->subCounty('Namasale Town Council');
# Retrieve all parishes in a particular sub county
$parishes = $uganda
->county('Namasale Town Council')
->parishes();
# Retrieve all villages in a particular sub county
$villages = $uganda
->county('Namasale Town Council')
->villages();
```
### Retrieve Parish data.
```php
use Uganda\Uganda;
$uganda = new Uganda();
# Retrieve all parishes
$parishes = $uganda->parishes();
# Retrieve specific parish
$parish = $uganda->parish('Bunamwamba');
# Retrieve all villages in a particular parish
$villages = $uganda
->county('Bunamwamba')
->villages();
```
### Retrieve Village data.
```php
use Uganda\Uganda;
$uganda = new Uganda();
# Retrieve all villages
$villages = $uganda->villages();
# Retrieve specific village
$subCounty = $uganda->village('Ayeye');
```
## Credits
The data used in this package has been scrapped off This data has been scrapped off [Uganda's passport's official portal](https://passports.go.ug) as there is no updated geo data source since 2018 published anywhere.
## Collaborators ✨
Tim3k
Joshua Kusaasira
Marshud
## Contributors ✨
## License
This package is free software distributed under the terms of the MIT license.
