GithubHelp home page GithubHelp logo

omdxp / leblad Goto Github PK

View Code? Open in Web Editor NEW
5.0 2.0 0.0 127 KB

A go module providing a list of Algerian administrative areas with many useful APIs, based on dzcode-io/leblad

License: MIT License

Go 100.00%
algeria algerian-administrative-areas dz go gomodule postal-codes wilayas hacktoberfest

leblad's Introduction

leblad

Build Status codecov Go Report Card

A go module providing a list of Algerian administrative areas with many useful APIs, based on dzcode-io/leblad

Installation

go get -u github.com/omdxp/leblad

Quick Start

package main

import (
    "fmt"

    "github.com/omdxp/leblad"
)

func main() {
    l := leblad.New()

    // Get all wilayas
    wilayas, err := l.GetWilayaList()
    if err != nil {
        panic(err)
    }

    fmt.Println(wilayas)

    // Get only wilayas names
    wilayas, err = l.GetWilayaList("name")
    if err != nil {
        panic(err)
    }
}

API

init a new leblad instance

l := leblad.New()

GetWilayaList

Get all wilayas

wilayas, err := l.GetWilayaList()
if err != nil {
    panic(err)
}

Filter wilayas by a specific field

wilayas, err := l.GetWilayaList("name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

wilayas, err := l.GetWilayaList("name", "dairats", "matricule")
if err != nil {
    panic(err)
}

fields can be one of the following:

wilaya field description
matricule wilaya matricule
name_ar wilaya name in arabic
name_ber wilaya name in berber
name_en wilaya name in english
name wilaya name in french
phoneCodes wilaya phone codes
postalCodes wilaya postal codes
dairats wilaya dairats
adjacentWilayas wilaya adjacent wilayas

GetWilayaByZipCode

Get wilaya by zip code

wilaya, err := l.GetWilayaByZipCode(1000)
if err != nil {
    panic(err)
}

Filter wilaya by a specific field

wilaya, err := l.GetWilayaByZipCode(1000, "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

wilaya, err := l.GetWilayaByZipCode(1000, "name", "dairats", "matricule")
if err != nil {
    panic(err)
}

GetWilayaByCode

Get wilaya by code

wilaya, err := l.GetWilayaByCode(1)
if err != nil {
    panic(err)
}

Filter wilaya by a specific field

wilaya, err := l.GetWilayaByCode(1, "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

wilaya, err := l.GetWilayaByCode(1, "name", "dairats", "matricule")
if err != nil {
    panic(err)
}

GetAdjacentWilayas

Get adjacent wilayas as a slice of wilaya codes

wilayas, err := l.GetAdjacentWilayas(1)
if err != nil {
    panic(err)
}

GetZipCodesForWilaya

Get zip codes for a wilaya

zipCodes, err := l.GetZipCodesForWilaya(1)
if err != nil {
    panic(err)
}

GetDairatsForWilaya

Get dairats for a wilaya

dairats, err := l.GetDairatsForWilaya(1)
if err != nil {
    panic(err)
}

Filter dairats by a specific field

dairats, err := l.GetDairatsForWilaya(1, "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

dairats, err := l.GetDairatsForWilaya(1, "name", "code", "baladyiats")
if err != nil {
    panic(err)
}

fields can be one of the following:

daira field description
code daira code
name daira name
name_ar daira name in arabic
name_en daira name in english
baladyiats daira baladyiats

GetWilayaByPhoneCode

Get wilaya by phone code

wilaya, err := l.GetWilayaByPhoneCode(49)
if err != nil {
    panic(err)
}

Filter wilaya by a specific field

wilaya, err := l.GetWilayaByPhoneCode(49, "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

wilaya, err := l.GetWilayaByPhoneCode(49, "name", "dairats", "matricule")
if err != nil {
    panic(err)
}

GetWilayaByDairaName

Get wilaya by daira name

wilaya, err := l.GetWilayaByDairaName("ADRAR")
if err != nil {
    panic(err)
}

Filter wilaya by a specific field

wilaya, err := l.GetWilayaByDairaName("ADRAR", "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

wilaya, err := l.GetWilayaByDairaName("ADRAR", "name", "dairats", "matricule")
if err != nil {
    panic(err)
}

GetBaladyiatsForDaira

Get baladyiats for a daira

baladyiats, err := l.GetBaladyiatsForDaira("ADRAR")
if err != nil {
    panic(err)
}

Filter baladyiats by a specific field

baladyiats, err := l.GetBaladyiatsForDaira("ADRAR", "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

baladyiats, err := l.GetBaladyiatsForDaira("ADRAR", "name", "code")
if err != nil {
    panic(err)
}

fields can be one of the following:

baladyia field description
code baladyia code
name baladyia name
name_ar baladyia name in arabic
name_en baladyia name in english

GetBaladyiatsForDairaCode

Get baladyiats for a daira code

baladyiats, err := l.GetBaladyiatsForDairaCode(101)
if err != nil {
    panic(err)
}

Filter baladyiats by a specific field

baladyiats, err := l.GetBaladyiatsForDairaCode(101, "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

baladyiats, err := l.GetBaladyiatsForDairaCode(101, "name", "code")
if err != nil {
    panic(err)
}

GetPhoneCodesForWilaya

Get phone codes for a wilaya

phoneCodes, err := l.GetPhoneCodesForWilaya("Adrar")
if err != nil {
    panic(err)
}

GetFirstPhoneCodeForWilaya

Get first phone code for a wilaya

phoneCode, err := l.GetFirstPhoneCodeForWilaya("Adrar")
if err != nil {
    panic(err)
}

GetBaladyiatsForWilaya

Get baladyiats for a wilaya

baladyiats, err := l.GetBaladyiatsForWilaya("Adrar")
if err != nil {
    panic(err)
}

Filter baladyiats by a specific field

baladyiats, err := l.GetBaladyiatsForWilaya("Adrar", "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

baladyiats, err := l.GetBaladyiatsForWilaya("Adrar", "name", "code")
if err != nil {
    panic(err)
}

GetWilayaByBaladyiaName

Get wilaya by baladyia name

wilaya, err := l.GetWilayaByBaladyiaName("ADRAR")
if err != nil {
    panic(err)
}

Filter wilaya by a specific field

wilaya, err := l.GetWilayaByBaladyiaName("ADRAR", "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

wilaya, err := l.GetWilayaByBaladyiaName("ADRAR", "name", "dairats", "matricule")
if err != nil {
    panic(err)
}

GetDairaByBaladyiaName

Get daira by baladyia name

daira, err := l.GetDairaByBaladyiaName("ADRAR")
if err != nil {
    panic(err)
}

Filter daira by a specific field

daira, err := l.GetDairaByBaladyiaName("ADRAR", "name")
if err != nil {
    panic(err)
}

it accept a variadic number of fields

daira, err := l.GetDairaByBaladyiaName("ADRAR", "name", "code")
if err != nil {
    panic(err)
}

Contributing

Contributions are welcome, please read the contributing guide for more information.

License

MIT

leblad's People

Contributors

omdxp avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

leblad's Issues

show test coverage

Is your feature request related to a problem? Please describe.
Test coverage are shown only in the output of the Test CI action.

Describe the solution you'd like
show test coverage as a badge

CI test workflow

Is your feature request related to a problem? Please describe.
When merging to main branch there should be a GitHub action to run test for the current commit.

Describe the solution you'd like
Have a test CI workflow so it can disable merging PR if there are test errors.

Describe alternatives you've considered
Running tests locally which is not good for DX.

use pointers as a return type for methods

Is your feature request related to a problem? Please describe.
Sometimes error occurs when using Leblad APIs, when that happens it returns the error but the an empty struct for the supposed result.

Describe the solution you'd like
Instead of returning empty structs, we should return nil and consequently using pointers as return types for the supposed results.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.