pyzipcode-cli

Python Versions Build Status

Author:: Tasdik Rahman

1 What is it?

Extract meta data like

city
state
county
location
- latitude
- longitude
Appropriate boundaries for that area

by just using the ZIPCODE and Country code

2 Features

Written in uncomplicated python
Supports all the Country codes specified in the ISO specification i.e all 264 countries where they have a pin code.

You can find a list of all the country codes at the Wiki page
Gives ouput in a dict form or a JSON format
Fast and easy to use

3 Installation

3.1 Option 1: installing through pip (Suggested way)

pypi package link

$ pip install pyzipcode-cli

If you are behind a proxy

$ pip --proxy [username:password@]domain_name:port install pyzipcode-cli

Note: If you get command not found then $ sudo apt-get install python-pip should fix that

3.2 Option 2: Installing from source

$ git clone https://github.com/prodicus/pyzipcode-cli.git
$ cd pyzipcode-cli/
$ pip install -r requirements.txt
$ python setup.py install

4 Usage

get()

>>> pz.get(603203, "IN", return_json=True)
{
  "location": {
    "lat": 12.8336666,
    "lng": 80.0199562
  },
  "city": "Kavanur",
  "state_short": "25",
  "county": "Kanchipuram",
  "state": "Tamil Nadu",
  "postal_code": "603203",
  "bounds": {
    "northeast": {
      "lat": 12.8769479,
      "lng": 80.0572497
    },
    "southwest": {
      "lat": 12.7997355,
      "lng": 79.9504465
    }
  },
  "location_type": "APPROXIMATE",
  "country": "IN"
}

5 To-do

[ ] Support timezone extraction
[ ] Add cli-support

6 Contributing

Feel free to make a pull request. For that, please refer the Contributing page

7 Bugs

Please report the bugs at the issue tracker

8 Known Issues

The zipcodes for Argentina are not working for the release 0.1.3 as reported by DavidVentura on issue #1

9 License :

MIT License © Tasdik Rahman

You can find a copy of the License at http://prodicus.mit-license.org/

Download files

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

Source Distribution

pyzipcode-cli-0.1.4.tar.gz (6.1 kB view details)

Uploaded Jan 16, 2016 Source

File details

Details for the file pyzipcode-cli-0.1.4.tar.gz.

File metadata

Download URL: pyzipcode-cli-0.1.4.tar.gz
Upload date: Jan 16, 2016
Size: 6.1 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for pyzipcode-cli-0.1.4.tar.gz
Algorithm	Hash digest
SHA256	`6be05afa74e7cda36d4298972b720726754548d295e8bb1660658e0eab896413`
MD5	`06a4d2b1f42a24fed799088b9d3a63b7`
BLAKE2b-256	`328837670f638c09a602bd6210d960fc870fdbc8c184aa6ab3a40bb42f4d3050`