https://github.com/athrocks/flask-postoffice-api
https://github.com/athrocks/flask-postoffice-api
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/athrocks/flask-postoffice-api
- Owner: athrocks
- License: mit
- Created: 2025-01-23T14:34:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T14:34:54.000Z (4 months ago)
- Last Synced: 2025-01-23T15:31:52.524Z (4 months ago)
- Language: HTML
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Post Office Finder
## Overview
A Flask-based web application to find post office details using an Indian postal code (pincode).
## Features
- Lookup post office details by 6-digit pincode
- Input validation
- Error handling for invalid pincodes
- Displays state, name, block, and district information
## Prerequisites
- Python 3.8+
- pip
## Setup
### 1. Clone the Repository
### 2. Create Virtual Environment
```bash
virtualenv myenv
source myenv/bin/activate # On Windows: myenv\Scripts\activate
```
### 3. Install Dependencies
```bash
pip install flask requests
```
### 4. Run the Application
```bash
python app.py
```
## Usage
1. Open browser to `http://localhost:5000`
2. Enter 6-digit pincode
3. View post office details
## API
Uses [Postal Pincode API](https://api.postalpincode.in/)
## Error Handling
- Validates 6-digit numeric input
- Displays error for invalid pincodes
## License
MIT License