Here's a comprehensive README.md file for your GitHub repository. It includes sections for project description, features, requirements, setup, and more.
This project is a web application for managing company PF (Provident Fund) details. It allows users to search for company details, scrape data, store it in a database, and display payment details in an organized manner.
# Company PF Details Management System
This project is a web application for managing company PF (Provident Fund) details. It allows users to search for company details, scrape data, store it in a database, and display payment details in an organized manner.
## Features
- **Search and Scrape**: Search for a company by name and scrape its PF-related data.
- **Database Integration**: Store and manage company details in a SQLite database.
- **Dynamic Table Display**: Display company data and payment details in a user-friendly table format.
- **Error Handling**: Handles errors during scraping and data processing gracefully.
- **Interactive UI**: Built with Django templates for dynamic rendering and user interaction.
- **CSV and Excel Handling**: Process and validate CSV/Excel files for data storage.
---
# Company PF Details Manager
A Django-based web application for managing and tracking company Provident Fund (PF) details and payment information.
## Features
- Search and retrieve company PF details
- Automated data scraping from EPFS portal
- Store and display company information
- Track payment details including TRRN, credit dates, and employee counts
- Export data to Excel/CSV formats
- Interactive data tables with sorting and filtering capabilities
## Prerequisites
- Python 3.x
- Django
- Selenium WebDriver
- Pandas
- SQLite3
## Installation
1. Clone the repository:
```bash
git clone https://github.com/your-username/company-pf-details.git
cd company-pf-details- Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate- Install required packages:
pip install -r requirements.txt- Set up the database:
python manage.py migrate├── CompanyList/ # Directory for downloaded company data
├── data/ # Directory for processed data files
├── static/ # Static files (CSS, JS)
├── templates/ # HTML templates
│ ├── base.html
│ ├── home.html
│ ├── show_table.html
│ └── payment_details.html
├── utils/ # Utility functions
│ ├── checker.py
│ ├── db_func.py
│ ├── forms.py
│ ├── scrapper.py
│ └── scrapper_final.py
└── main.py # Main application file
- Start the development server:
python main.py-
Open your web browser and navigate to
http://localhost:8004 -
Use the search form to look up company details
-
Select companies from the table to fetch their payment details
-
View and manage payment information in the payment details section
- establishment_id (Primary Key)
- establishment_name
- address
- office_name
- company_name
- trrn
- date_of_credit
- amount
- wage_month
- no_of_employee
- ecr
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.