# Nigerian Bank List (banklist-ng)
The `banklist-ng` library provides information about Nigerian banks including the bank's type, NIP code, name, slug, code, USSD, and logo.
## Usage
### Installation
You can install the package via pip:
```bash
pip install banklist-ng
```
### Importing
```python
from banklist_ng import fetch_banks, filter_banks_by_keyword
# Fetch all banks data
all_banks_data = fetch_banks()
print(all_banks_data)
# Filter banks by keyword
keyword = "Zenith"
zenith_banks = filter_banks_by_keyword(keyword)
print(f"Banks matching '{keyword}':", zenith_banks)
```
### Functions
- `fetch_banks() -> List[BankInfo]`: Fetches a list of all Nigerian banks with their data.
- `filter_banks_by_keyword(keyword: str) -> List[BankInfo]`: Filters banks based on a given keyword in their name property.
### Type Definitions
- `BankInfo`: Represents the data structure for information about a bank, including its ID, type, NIP code, name, slug, code, USSD, and logo.
### JSON Data
The bank data is sourced from a JSON file included with the package. The JSON file contains comprehensive information about each bank.
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please fork the repository and submit a pull request with your changes.
## GitHub Repository
You can find the source code and contribute to this project on GitHub: [Bank List NG on GitHub](https://github.com/awesomegoodman/banklist-ng)
Raw data
{
"_id": null,
"home_page": "https://github.com/awesomegoodman/banklist-ng/tree/main/pypi",
"name": "banklist-ng",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Nigerian Banks List,Nigerian Bank Codes,Nigerian Banks Logos,Banks in Nigeria",
"author": "Awesome Goodman",
"author_email": "goodman.awesome@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/30/979c1faf945565985b9220a78b40c278766c3a9fd67171957d1c64f0b310/banklist_ng-0.0.1.tar.gz",
"platform": null,
"description": "# Nigerian Bank List (banklist-ng)\r\n\r\nThe `banklist-ng` library provides information about Nigerian banks including the bank's type, NIP code, name, slug, code, USSD, and logo.\r\n\r\n## Usage\r\n\r\n### Installation\r\n\r\nYou can install the package via pip:\r\n\r\n```bash\r\npip install banklist-ng\r\n```\r\n\r\n### Importing\r\n\r\n```python\r\nfrom banklist_ng import fetch_banks, filter_banks_by_keyword\r\n\r\n# Fetch all banks data\r\nall_banks_data = fetch_banks()\r\nprint(all_banks_data)\r\n\r\n# Filter banks by keyword\r\nkeyword = \"Zenith\"\r\nzenith_banks = filter_banks_by_keyword(keyword)\r\nprint(f\"Banks matching '{keyword}':\", zenith_banks)\r\n```\r\n\r\n### Functions\r\n\r\n- `fetch_banks() -> List[BankInfo]`: Fetches a list of all Nigerian banks with their data.\r\n\r\n- `filter_banks_by_keyword(keyword: str) -> List[BankInfo]`: Filters banks based on a given keyword in their name property.\r\n\r\n### Type Definitions\r\n\r\n- `BankInfo`: Represents the data structure for information about a bank, including its ID, type, NIP code, name, slug, code, USSD, and logo.\r\n\r\n### JSON Data\r\n\r\nThe bank data is sourced from a JSON file included with the package. The JSON file contains comprehensive information about each bank.\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you'd like to contribute to this project, please fork the repository and submit a pull request with your changes.\r\n\r\n## GitHub Repository\r\n\r\nYou can find the source code and contribute to this project on GitHub: [Bank List NG on GitHub](https://github.com/awesomegoodman/banklist-ng)\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Information about Nigerian banks including the bank's type, NIP code, name, slug, code, USSD, and logo.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/awesomegoodman/banklist-ng/tree/main/pypi"
},
"split_keywords": [
"nigerian banks list",
"nigerian bank codes",
"nigerian banks logos",
"banks in nigeria"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8e20a495b3e64d1fb3c6d0e7f618d58c192ab490807930b62333e8b6f419fbc",
"md5": "bd3b4e40032f50791990ee4eb86da756",
"sha256": "9b3c6819a22db456792e1258abb12e9b1aa105da91b092747187619701afdbf0"
},
"downloads": -1,
"filename": "banklist_ng-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd3b4e40032f50791990ee4eb86da756",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8752,
"upload_time": "2024-03-05T01:30:18",
"upload_time_iso_8601": "2024-03-05T01:30:18.151765Z",
"url": "https://files.pythonhosted.org/packages/e8/e2/0a495b3e64d1fb3c6d0e7f618d58c192ab490807930b62333e8b6f419fbc/banklist_ng-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7030979c1faf945565985b9220a78b40c278766c3a9fd67171957d1c64f0b310",
"md5": "2d776d1f9232181aad576d3bd1b8f0f6",
"sha256": "b6ef19ae338eaa6c64bcebcc5cf1031b8c7426f2317bceab407a78074da8072d"
},
"downloads": -1,
"filename": "banklist_ng-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2d776d1f9232181aad576d3bd1b8f0f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9851,
"upload_time": "2024-03-05T01:30:21",
"upload_time_iso_8601": "2024-03-05T01:30:21.482565Z",
"url": "https://files.pythonhosted.org/packages/70/30/979c1faf945565985b9220a78b40c278766c3a9fd67171957d1c64f0b310/banklist_ng-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 01:30:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awesomegoodman",
"github_project": "banklist-ng",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "banklist-ng"
}
JSON
