Metadata-Version: 2.1
Name: bsb-lookup
Version: 0.0.1rc15.post1
Summary: Sample Python Project for creating a new Python Module
Author-email: Ilan Kessler <ilan@refundid.com>
Requires-Python: >=3.8.1
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: black==23.3.0 ; extra == "test"
Requires-Dist: check-manifest==0.49 ; extra == "test"
Requires-Dist: ruff==0.1.3 ; extra == "test"
Requires-Dist: mypy==1.6.1 ; extra == "test"
Requires-Dist: pre-commit==3.3.1 ; extra == "test"
Requires-Dist: pytest==7.4.3 ; extra == "test"
Project-URL: Documentation, https://github.com/microsoft/python-package-template/tree/main#readme
Project-URL: Source, https://github.com/microsoft/python-package-template
Project-URL: Tracker, https://github.com/microsoft/python-package-template/issues
Provides-Extra: test

# BSB Lookup

[![pypi](https://img.shields.io/pypi/v/bsb-lookup.svg)](https://pypi.python.org/pypi/bsb-lookup)
[![versions](https://img.shields.io/pypi/pyversions/bsb-lookup.svg)](https://github.com/ilankessler/bsb-lookup)
[![license](https://img.shields.io/github/license/ilankessler/bsb-lookup.svg)](https://github.com/ilankessler/bsb-lookup/blob/main/LICENSE)

Australian Bank State Branch number enricher used for validating and looking up bank names given a BSB number. Ideal for financial applications, banking software, and fintech solutions.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Installation

Before installing, ensure you have Python 3.x installed on your system. You can install BSB Lookup using pip:

```bash
pip install bsb-lookup
```

## Usage

Here's a simple example to get started with BSB Lookup:

```py
from bsb import to_bank_info

result = to_bank_info(bsb="082055")

# >>> BankInfo(
# ...     prefix_rule=BSBPrefixRule(key="NAB", abbreviation="National Australia Bank Limited", bsb_prefixes=["08"]),
# ...     directory_entry=BSBDirectoryRow(
# ...         bsb="082055",
# ...         financial_institution_code="NAB",
# ...         name="Private NSW Banking Suite",
# ...         street="Level 5 2 Carrington St",
# ...         suburb="Sydney",
# ...         state="NSW",
# ...         postcode="2000",
# ...         payments_flag="PEH",
# ...     ),
# ...     npp_support=NPPSupport.SUPPORTED,
# ... )

```

## API Reference

The main functions in BSB Lookup are:

- `to_bank_info`: Converts a BSB number to detailed bank information.
- [Other functions and classes with brief descriptions]

For full documentation, visit [Link to Documentation].

## Contributing

Contributions are welcome! If you have a suggestion or want to contribute code, please follow these steps:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -am 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request


## License

This project is licensed under the [MIT License](https://github.com/ilankessler/bsb-lookup/blob/main/LICENSE) - see the LICENSE file for details.

## Contact

For support or queries, reach out to ilan@refundid.com or join our [Community Forum/Discord](#link-to-community-platform).

