Welcome to postalcodes-ni’s documentation!

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
)

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 import the functions 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

Installation

Stable release

To install postalcodes-ni, run this command in your terminal:

$ pip install postalcodes_ni

This is the preferred method to install postalcodes-ni, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for postalcodes-ni can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/oscarmcm/postalcodes-ni

Or download the tarball:

$ curl  -OL https://github.com/oscarmcm/postalcodes-ni/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

postalcodes_ni

postalcodes_ni package

Submodules

postalcodes_ni.exceptions module

exception postalcodes_ni.exceptions.ISOCodeError[source]

Bases: Exception

Thrown when ISO code doesnt exists

exception postalcodes_ni.exceptions.PostalCodeError[source]

Bases: Exception

Thrown when postal code doesnt exists

postalcodes_ni.postalcodes module

postalcodes_ni.postalcodes.get_all_municipalities_by_iso(iso_code: str) → list[source]

Returns all the municipalities for a department based on the ISO code

postalcodes_ni.postalcodes.get_all_municipalities_by_postal(postal_code: int) → list[source]

Returns all the municipalities for a department based on the postal code

postalcodes_ni.postalcodes.get_municipality_by_name(name: str) → tuple[source]

Returns a single record for a municipality based on the name

postalcodes_ni.postalcodes.get_municipality_by_postal(postal_code: int) → dict[source]

Returns a single record for a municipality based on the postal code

Module contents

Top-level package for postalcodes-ni.

postalcodes_ni.get_all_municipalities_by_iso(iso_code: str) → list[source]

Returns all the municipalities for a department based on the ISO code

postalcodes_ni.get_all_municipalities_by_postal(postal_code: int) → list[source]

Returns all the municipalities for a department based on the postal code

postalcodes_ni.get_municipality_by_name(name: str) → tuple[source]

Returns a single record for a municipality based on the name

postalcodes_ni.get_municipality_by_postal(postal_code: int) → dict[source]

Returns a single record for a municipality based on the postal code

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/oscarmcm/postalcodes-ni/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

postalcodes-ni could always use more documentation, whether as part of the official postalcodes-ni docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/oscarmcm/postalcodes-ni/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up postalcodes_ni for local development.

  1. Fork the postalcodes-ni repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/postalcodes-ni.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv postalcodes_ni
$ cd postalcodes-ni/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 postalcodes_ni tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/oscarmcm/postalcodes-ni/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_postalcodes_ni

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

1.0.0 (2019-03-27)

  • First release on PyPI.

Indices and tables