Metadata-Version: 2.1
Name: django-mikoa
Version: 0.0.2
Summary: Django app for Tanzania Regions and Districts
Home-page: https://github.com/devmed/django-mikoa
Author: Medson Naftali
Author-email: medsonnaftal@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/devmed/django-mikoa/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# django-mikoa

A Django application consisting of all Tanzania locations from Regions to District.

## Prerequisites

* Python 3.6+
* Pip or Pipenv

## It will Cover

* [x] Regions (region, capital, number of districts, area, population, postcode and zone)
* [x] Districts (district, region, population)
* [ ] Wards
* [ ] Vilage/Streets

## Installation

This package is available in [Python Package Index](https://pypi.org/project/django-mikoa/) and can be installed using `pip` or `pipenv`

1. Run ``pip install django-mikoa``
2. Add ``mikoa`` to ``INSTALLED_APPS``
3. Run ``python manage.py migrate``

## Usage

### To access Tanzania Regions

```python
from mikoa.models import Region
regions = Region.objects.all()

print(regions)
```

### To access Tanzania Districts

```python
from mikoa.models import District
districts = District.objects.all()

print(districts)
```

### To access all Districts of Certain Region

```python
from mikoa.models import Region, District
regions = Region.objects.all()

for region in regions:
    for district in region.district_set.all():
        print(district.region.name)
        print(district.name)   
```

## Give it a star

If you found this repository useful, give it a star so as the whole galaxy of developer can get to know it.

## Bug bounty?

If you encounter issue with the usage of the package, feel free raise an issue so as we can fix it as soon as possible(ASAP).

## Pull Requests

If you have something to add I welcome pull requests on improvement , you're helpful contribution will be merged as soon as possible

## Disclaimer

All the location I used to build this repository, I got from an public repository titled [tanzania-locations-db](https://github.com/HackEAC/tanzania-locations-db), I'm not responsible for any kind of misinformation in it, So use it to your own risk


