Metadata-Version: 2.1
Name: indiapins
Version: 0.1.4
Summary: Python package for mapping pins to the place where it belong
Home-page: https://github.com/pawangeek/indiapins
Author: Pawan Kumar Jain
Author-email: pawanjain.432@gmail.com
License: MIT license
Keywords: indiapins india pincodes zipcodes
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.7
License-File: LICENSE
License-File: AUTHORS.rst

=========
indiapins
=========


.. image:: https://img.shields.io/pypi/v/indiapins.svg
        :target: https://pypi.python.org/pypi/indiapins

.. image:: https://img.shields.io/travis/pawangeek/indiapins.svg
        :target: https://travis-ci.com/pawangeek/indiapins

.. image:: https://readthedocs.org/projects/indiapins/badge/?version=latest
        :target: https://indiapins.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/pawangeek/indiapins/shield.svg
     :target: https://pyup.io/repos/github/pawangeek/indiapins/
     :alt: Updates


**Indiapins is a Python package for getting the places tagged to particular Indian pincode**

* Free software: MIT license
* Documentation: https://indiapins.readthedocs.io.
* Github Repo: https://github.com/pawangeek/indiapins
* PyPI: https://pypi.org/project/indiapins/


Installation
------------

Install the plugin using 'pip':

.. code-block:: shell

   $ pip install indiapins

Alternatively, install from source by cloning this repo then running
'setup.py':

.. code-block:: shell

   $ python setup.py install


Features
--------
* Get all the mappings of given pins
* The Python sqlite3 module is not required, so easily to use in Clouds (no additional dependencies)
* Works with Python 3.6, 3.7, 3.8, 3.9, and PyPy
* Cross-platform: Windows, Mac, and Linux are officially supported.
* Simple usage and very fast results


Examples
--------

1. Exact Match
##############

To find the names of all places, districts, circles and related information by given Indian Pincode

**Important: The Pincode should be of 6 digits, in string format**

.. code-block:: python

    indiapins.matching('110011')

    [{'Name': 'Nirman Bhawan', 'BranchType': 'Sub Post Office', 'DeliveryStatus': 'Delivery', 'Circle': 'Delhi', 'District': 'Central Delhi', 'Division': 'New Delhi Central', 'Region': 'Delhi', 'Block': 'New Delhi', 'State': 'Delhi', 'Country': 'India', 'Pincode': '110011'}, 
    {'Name': 'South Avenue', 'BranchType': 'Sub Post Office', 'DeliveryStatus': 'Non-Delivery', 'Circle': 'Delhi', 'District': 'Central Delhi', 'Division': 'New Delhi Central', 'Region': 'Delhi', 'Block': 'New Delhi', 'State': 'Delhi', 'Country': 'India', 'Pincode': '110011'}, 
    {'Name': 'Udyog Bhawan', 'BranchType': 'Sub Post Office', 'DeliveryStatus': 'Non-Delivery', 'Circle': 'Delhi', 'District': 'Central Delhi', 'Division': 'New Delhi Central', 'Region': 'Delhi', 'Block': 'New Delhi', 'State': 'Delhi', 'Country': 'India', 'Pincode': '110011'}]


2. Valid Pincode
################

To check if the given Pincode is valid or not

.. code-block:: python

    indiapins.isvalid('110011')

    True

3. District by Pincode
######################

It extracts the district of given Indian pincode

.. code-block:: python

    indiapins.districtmatch('302005')

    'Jaipur'



=======
History
=======

0.1.0 (2021-07-27)
------------------

* Match location with the pins
* Mark pin is valid or not
* Extract cities on basis of pins 
