Metadata-Version: 2.1
Name: indian-states
Version: 1.1
Summary: India's states and cities
Home-page: https://github.com/ArunKumar006/indian-states
Author: Rishabh Batra
Author-email: arunyuvi0206@gmail.com
License: UNKNOWN
Description: # India package
        
        ![deployment](https://github.com/rishabhbatra10/in/workflows/deployment/badge.svg)
        #### Version 1.1
        ### Installation
        Installation Using pip
        ```bash
        pip install indian-states
        ```
        
        #### Running Tests
        
        ```bash
        python -m unittest discover -s tests
        ```
        ### Usage
        This repository makes it easy to access metadata of states and union territories of India.
        ```python
        >>> import india
        >>> india.states.AR
        OUT: <State: Arunachal Pradesh>
        ```
        
        You can also lookup whether your input is state or not.
        ```python
        >>> import india
        >>> india.states.lookup('arunachal pradesh')
        OUT: <State: Arunachal Pradesh>
        ```
        
        New release enables you to access districts/cities across india with several attributes
        ```python
        >>> import india
        >>> india.cities.KA_BLR
        OUT: <City: Bangalore>
        
        ```
        
        New release enables you to track post offices based on pincode
        ```python
        >>> from india import pincodes
        >>> pincodes.lookup('691522')
        OUT: ['Panthaplavu B.O', 'Pattazhy S.O', 'Thekketheri B.O']
        
        ```
        
        Lookup for cities
        ```python
        >>> import india
        >>> india.cities.lookup('Bangalore')
        OUT: <City: Bangalore>
        ```
        
        Check whether the city is capital
        ```python
        >>> import india
        >>> india.cities.lookup('Bangalore').iscapital()
        OUT: True
        ```
        
        ### Attributes
        
        Attributes of state object
        
        ```python
        state.name       # name of the state
        state.capital    # returns the capital of that state
        state.population # returns the population of the state
        state.area       # returns the area of state in km^2
        state.density    # returns population density per km^2 of state
        state.language   # primary official language of the state
        ```
        
        Attributes of Cities object
        
        ```python
        city.name       # name of the city
        city.state      # returns the state of city
        city.population # returns the population of the city
        city.area       # returns the area of the district
        city.density    # returns population density per km^2 of the city
        city.url        # returns official webpage of the city
        ```
        
        ### Release Notes
        <li> Added option to list all post offices under given pincode
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
