Skip to main content

PyPI version License Python Versions Build Status Requirements 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/

Metadata

Release files for pyzipcode-cli 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyzipcode-cli 0.1.4
File Size Uploaded Provenance
pyzipcode-cli-0.1.4.tar.gz 6.1 kB Without provenance Details

Release files / pyzipcode-cli-0.1.4.tar.gz

Download URL pyzipcode-cli-0.1.4.tar.gz
Size 6.1 kB
Tags Source
SHA-256 checksum
How to use checksums
6be05afa74e7cda36d4298972b720726754548d295e8bb1660658e0eab896413
BLAKE2b-256 checksum
How to use checksums
328837670f638c09a602bd6210d960fc870fdbc8c184aa6ab3a40bb42f4d3050
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pyzipcode-cli 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page