Skip to main content

Python package for handle Nicaragua postal codes

Project description

postalcodes-ni

Python package for handle Nicaragua postal codes

made-with-python made-with-python PyPI version Travis-ci GitHub version Documentation Status

Quickstart

Install postalcodes-ni:

$ pip install postalcodes-ni

Then use it in your project:

from postalcodes_ni import (
    get_all_municipalities_by_iso, get_all_municipalities_by_postal,
    get_municipality_by_name, get_municipality_by_postal
)

You can find the documentation in https://postalcodes-ni.readthedocs.io

This package uses data from those websites:

Usage

postalcodes_ni exposes the following methods:

  • get_all_municipalities_by_iso for get all the municipalities in a department using the ISO code - Ex MN for Managua department.
  • get_all_municipalities_by_postal for get all the municipalities in a department using the postal code - Ex 10000 for Managua department.
  • get_municipality_by_name for get an specific municipality using his name - Ex Altagracia for the Rivas department.
  • get_municipality_by_postal for get an specific municipality using his postal code - Ex 48800 for the municipality of Altagracia from Rivas department.

Example

First, you need import the methods that you want to use

from postalcodes_ni import (
    get_all_municipalities_by_iso, get_all_municipalities_by_postal,
    get_municipality_by_name, get_municipality_by_postal
)

For get all the municipalities in a department use the following methods

>>> # Get all the municipalities in Carazo department using iso code
>>> get_all_municipalities_by_iso('CA')
[('Jinotepe', 45000), ('Dolores', 46100), ('El Rosario', 46200), ...]

>>> # Get all the municipalities in Carazo department using postal code
>>> get_all_municipalities_by_postal(45000)
[('Jinotepe', 45000), ('Dolores', 46100), ('El Rosario', 46200), ...]

For get an specific municipality in a department use the following methods

>>> # Get a municipality using his name
>>> get_municipality_by_name('nindiri')
('Nindirí', 42200)

>>> # Get a municipality using his postal code
>>> get_municipality_by_postal(42500)
('Catarina', 42500)

Running Tests

Does the code actually work?

$ source env/bin/activate
(env) $ pip install -r requirements_dev.txt
(env) $ make test-all

History

1.0.0 (2019-03-27)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

postalcodes_ni-1.2.0.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

postalcodes_ni-1.2.0-py2.py3-none-any.whl (16.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file postalcodes_ni-1.2.0.tar.gz.

File metadata

  • Download URL: postalcodes_ni-1.2.0.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for postalcodes_ni-1.2.0.tar.gz
Algorithm Hash digest
SHA256 a215459a1082143b04259854eb1efd9a14b4f76a9de7b1310ade159a9f0df861
MD5 6de677dc8692f8f0a7db70c9ef2674c0
BLAKE2b-256 d6c875388d45539e35cf3c8bf87926569a89c544fcf7f311c90f24aad68d8f87

See more details on using hashes here.

File details

Details for the file postalcodes_ni-1.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: postalcodes_ni-1.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for postalcodes_ni-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2a488e7ba91498ce52f98f2ab269f761c603c0e97ba6523ae8fb50455a65c602
MD5 3a0099ef0cb19267c433476be1ffe7a8
BLAKE2b-256 697efba5d0941dbe90adde916fe60d52acbbf01259d5226e2cbe8e2fb9b6c5ef

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page