# Zam-Authentic
Zam-Authentic is a Python package that provides validation functions for applications created in Zambia. It includes
validation for phone numbers, National Registration Card (NRC) numbers, and location data.
## GitHub Link
https://github.com/Munalula-Sikazwe/ZamAuthentic
## Installation
You can install Zam-Authentic using pip:
Copy code
```commandline
pip install zam-authentic
```
Usage
Phone Number Validation
To validate a phone number, you can use the phonenumber_is_valid function:
python
Copy code
``` python
from zam_authentic.phone_number_validation import phonenumber_is_valid
is_valid = phonenumber_is_valid('+260978123456') # Returns True
```
## NRC Validation
To validate an NRC number, you can use the validate_nrc function:
python
Copy code
```python
from zam_authentic.nrc_validation.validate import validate_nrc
is_valid = validate_nrc('123456/78/9', delimiter='/') # Returns True
```
Location Data Validation
To validate location data, you can use the validate_location function:
python
Copy code
License
This project is licensed under the MIT License - see the LICENSE file for details.
Get Districts
To get a list of districts in Zambia, you can use the get_districts function:
python
Copy code
```python
from zam_authentic.locations.get_locations import get_districts
districts = get_districts('province-name')
```
## Returns a list of district names
# Get Provinces
To get a list of provinces in Zambia, you can use the get_provinces function:
python
Copy code
```python
from zam_authentic.locations.get_locations import get_provinces
provinces = get_provinces()
```
## Returns a list of province names
# Get Constituencies
To get a list of constituencies in Zambia, you can use the get_constituencies function:
python
Copy code
```python
from zam_authentic.locations.get_locations import get_constituencies
constituencies = get_constituencies("district-name")
```
print(constituencies) # Returns a list of constituency names
## Documentation
For full documentation follow the link -> https://zamauthentic.readthedocs.io/en/latest/
## Disclaimer
This package is intended for educational purposes only and is not intended to be used in production systems without
proper review and testing. The authors of this package are not responsible for any damages that may occur as a result of
using this package. Use at your own risk.
Raw data
{
"_id": null,
"home_page": "",
"name": "zam-authentic",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "validation,zambia,zambia_kyc,kyc",
"author": "Munalula Sikazwe",
"author_email": "munalulasikazwe67@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4f/00/fcbde5608ac1670c730783247aca42aab4b4e5e9dfdeeadbc40d0dc64615/zam_authentic-0.0.13.tar.gz",
"platform": null,
"description": "# Zam-Authentic\r\n\r\nZam-Authentic is a Python package that provides validation functions for applications created in Zambia. It includes\r\nvalidation for phone numbers, National Registration Card (NRC) numbers, and location data.\r\n\r\n## GitHub Link\r\n\r\n https://github.com/Munalula-Sikazwe/ZamAuthentic\r\n\r\n## Installation\r\n\r\nYou can install Zam-Authentic using pip:\r\n\r\nCopy code\r\n\r\n```commandline\r\npip install zam-authentic\r\n```\r\n\r\nUsage\r\nPhone Number Validation\r\nTo validate a phone number, you can use the phonenumber_is_valid function:\r\n\r\npython\r\nCopy code\r\n\r\n``` python\r\nfrom zam_authentic.phone_number_validation import phonenumber_is_valid\r\n\r\nis_valid = phonenumber_is_valid('+260978123456') # Returns True\r\n```\r\n\r\n## NRC Validation\r\n\r\nTo validate an NRC number, you can use the validate_nrc function:\r\n\r\npython\r\nCopy code\r\n\r\n```python\r\nfrom zam_authentic.nrc_validation.validate import validate_nrc\r\n\r\nis_valid = validate_nrc('123456/78/9', delimiter='/') # Returns True\r\n\r\n```\r\n\r\nLocation Data Validation\r\nTo validate location data, you can use the validate_location function:\r\n\r\npython\r\nCopy code\r\n\r\nLicense\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\nGet Districts\r\nTo get a list of districts in Zambia, you can use the get_districts function:\r\n\r\npython\r\nCopy code\r\n\r\n```python\r\nfrom zam_authentic.locations.get_locations import get_districts\r\n\r\ndistricts = get_districts('province-name')\r\n```\r\n\r\n## Returns a list of district names\r\n\r\n# Get Provinces\r\n\r\nTo get a list of provinces in Zambia, you can use the get_provinces function:\r\n\r\npython\r\nCopy code\r\n\r\n```python\r\nfrom zam_authentic.locations.get_locations import get_provinces\r\n\r\nprovinces = get_provinces()\r\n```\r\n\r\n## Returns a list of province names\r\n\r\n# Get Constituencies\r\n\r\nTo get a list of constituencies in Zambia, you can use the get_constituencies function:\r\n\r\npython\r\nCopy code\r\n\r\n```python\r\nfrom zam_authentic.locations.get_locations import get_constituencies\r\n\r\nconstituencies = get_constituencies(\"district-name\")\r\n```\r\n\r\nprint(constituencies) # Returns a list of constituency names\r\n## Documentation\r\nFor full documentation follow the link -> https://zamauthentic.readthedocs.io/en/latest/\r\n## Disclaimer\r\nThis package is intended for educational purposes only and is not intended to be used in production systems without\r\nproper review and testing. The authors of this package are not responsible for any damages that may occur as a result of\r\nusing this package. Use at your own risk.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A validation library for Zambia",
"version": "0.0.13",
"split_keywords": [
"validation",
"zambia",
"zambia_kyc",
"kyc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb8a6555ed072f9ddb99e9dc83b768e6b0cc8450c88d08b74c3ca17211fd8341",
"md5": "2749bc17f44896baec6a8a94cafc0559",
"sha256": "2983498fa122cac72bfd787a4b43ac60eee45db9c0d100c3fee8838c0862e538"
},
"downloads": -1,
"filename": "zam_authentic-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2749bc17f44896baec6a8a94cafc0559",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14095,
"upload_time": "2023-03-21T18:35:23",
"upload_time_iso_8601": "2023-03-21T18:35:23.716325Z",
"url": "https://files.pythonhosted.org/packages/fb/8a/6555ed072f9ddb99e9dc83b768e6b0cc8450c88d08b74c3ca17211fd8341/zam_authentic-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f00fcbde5608ac1670c730783247aca42aab4b4e5e9dfdeeadbc40d0dc64615",
"md5": "5b4285132134b6a8e3d3fbc5d1e5c88a",
"sha256": "514abecee719f5475dca9a1e00fd5684b348b4a628ccf43f5c8afe84166de16e"
},
"downloads": -1,
"filename": "zam_authentic-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "5b4285132134b6a8e3d3fbc5d1e5c88a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11855,
"upload_time": "2023-03-21T18:35:25",
"upload_time_iso_8601": "2023-03-21T18:35:25.826530Z",
"url": "https://files.pythonhosted.org/packages/4f/00/fcbde5608ac1670c730783247aca42aab4b4e5e9dfdeeadbc40d0dc64615/zam_authentic-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-21 18:35:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "zam-authentic"
}
JSON