From 1b519c2ab1e3cca275e577bc3ec194afcba84af2 Mon Sep 17 00:00:00 2001 From: Ayesha Anwar Date: Fri, 7 Aug 2026 16:51:58 +0500 Subject: [PATCH] Updated Changelog.md and Minor fixes in other files --- CHANGELOG.md | 26 ++++++++++++++++---------- CONTRIBUTORS.md | 2 +- README.md | 2 +- 3 files changed, 18 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f71b482..79045e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,12 +2,12 @@ All notable changes to the `faker-pk` project will be documented in this file. -## [v2.0.0] +## [v0.2.0] - Aug 4, 2026 ### Added - **SQLite Database Architecture**: Migrated data storage from static Python dictionaries to an optimized SQLite database backend (`faker_pk.db`) for faster, maintainable queries. -- **Education Module (`education.py`)**: Added support for generating localized Pakistani education data, including degree levels, majors, universities, grading metrics, and complete student profiles. -- **15 Industry Sectors**: Expanded company and job generation across 15 distinct industry sectors (IT/Software, Banking, Healthcare, Textile, Agriculture, Telecommunications, FMCG, Petroleum, Logistics, Media, etc.). +- **Education Module (`education.py`)**: Added support for generating localized Pakistani education data, including degree levels, universities and complete student profiles. +- **15 Industry Sectors**: Expanded company and job generation across 15 distinct industry sectors (IT/Software, Banking, Healthcare, Textile, Agriculture, Telecommunications, Media, etc.). - **Industry-Aware Financial Data**: Added realistic job-level salary ranges (PKR), bank names, and valid formatted IBAN generation. - **Faker Provider Integration**: Custom provider class `FakerPKProvider` for seamless integration into the standard `faker` library ecosystem. - **GitHub Actions CI/CD Pipeline**: Configured automated test suites, pytest execution, and coverage tracking workflow. @@ -15,18 +15,24 @@ All notable changes to the `faker-pk` project will be documented in this file. ### Changed - **Modularized Test Suite**: Split test scripts into 26+ focused unit test modules in `tests/` covering personal, address, company, education, and provider interfaces. - **Packaging & Build System**: Standardized package setup using `pyproject.toml` and setuptools configuration. -- **Documentation**: Overhauled `README.md` with complete API reference tables, installation instructions, usage examples, and author/maintainer metadata. ### Improved - **Test Coverage**: Increased code coverage from unmonitored baseline to **>90%**. - **CNIC & Gender Parity Validation**: Ensured strict formatting (`xxxxx-xxxxxxx-x`) and accurate gender matching based on CNIC last digit rules. --- - -## [v1.0.0] - Initial Legacy Release +## [v0.1.9] - Sep 18, 2025 ### Added -- Initial Pakistani personal data generation (male/female names, CNIC numbers, mobile numbers, network providers). -- Basic address generation (cities, provinces, full addresses). -- Basic company names and job titles. -- Initial package structure for PyPI distribution. +- Industry-aware salary generation with refined distributions aligned to actual industry tiers across entry, mid, and senior levels. +- Provider API standardization — all provider methods follow `pk_*` naming convention for parity with core Faker. + +### Changed +- Improved city–province mappings for more consistent address generation. +- Cleaner formatting for `full_address()` output across urban and regional locations. +- Updated datasets for names, companies, and industries with reduced edge-case repeats. + +### Improved +- More stable CNIC and phone number generation with fewer duplicates. +- Salary variation across experience levels within each industry. +- Internal codebase cleanup, minor fixes, and optimization across modules. \ No newline at end of file diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 29f0f46..6b9377b 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,4 +1,4 @@ # Contributors * **Muhammad Khubaib Ahmad** - Creator, project lead, and maintainer. -* **Ayesha Anwar** - Major contributor to the v2.0 release, including feature development and code improvements as open-source contributor under INFERENCE Lab. +* **Ayesha Anwar** - Major contributor to the v0.2.0 release, including feature development and code improvements as open-source contributor under INFERENCE Lab. diff --git a/README.md b/README.md index 36b393b..5fe8656 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ It also fully integrates as a **Faker Provider** so you can seamlessly use it in - **INFERENCE Lab** (`contact@inference-lab.org`) - Organization ## Maintainers -- **Ayesha Anwar** (`hayesha1744@gmail.com`) - Lead developer of `faker-pk` v2.0 +- **Ayesha Anwar** (`hayesha1744@gmail.com`) - Lead developer of `faker-pk` v0.2.0 - **INFERENCE Lab** (`contact@inference-lab.org`) - Project organization ---