semvec/pypi-packages huggingface dataset:
flanellograf 0.4.2
Tool for making presentations using the Python REPL
Requires Python: >=3.9
Keywords: presentation, repl, code, documentation

# Flanellograf [flanellogrˈaf]

_Flanellograf_ is a tool for making presentations in the Python REPL (it is not a terminal user interface (TUI), at every slide you are in the interactive repl with access to the code from the slide).

This is a quick and dirty WIP prototype and making the slideshow interactive in the REPL involves some serious python hackery. There are ruff edges, beware.

A slide can contain a title, markdown content and Python code. Python code in the slide is ran as you go trough the presentation, meaning that any example in a slide can be further explained using the REPL.

## Installation
The tool will work on Python 3.9 and above, however with the improvements to the REPL in Python 3.13, that version is recomended (especially the multiline editing feature, but built in syntax highlighting is also nice). 

The code is published to PyPI so `pip install flanellograf` should work, it will also install it's only requirement `rich`. 

You could also clone or zip this project and run `pip install .`.

It's prefered to install _Flanellograf_ into a virtual environment regardless of installation method.

If you are presenting some code from your own project just add `flanellograf` as a dev-dependency and check the slides into git. This way the presentation can be part of the documentation of your project. You can use your development tools like linter and formaters, and even test your presentation (mind-blown) giving you a heads up if change break one of your slides.

## Usage

For now flanellograf must be called as a module with a path parameter:
`python -im flanellograf path_to_folder_or_file`

Any file found in path with the glob pattern `**/board_*.py` will be read as a board and listed in the TOC.

See the `examples` directory for how to make a board.

### Navigation
A shorthand name for your board(s) are automatically made (they are listed in the TOC shown at startup). With the example board named `board_example.py` the shorthand becomes `e`.

`~e`
: Refresh current slide (remove anything you have done in the REPL)

`e`
: Next slide

`-e`
: Previous slide

`+e`
: Jump to first slide

`e(n)`
: Jump to slide number n, where n is an integer. (Negative numbers count from the end)


## Inspiration
Inspiration and ideas for making this tool.

- Talks by David Beazley at PyOhio 2016 and PyData Chicago 2016
    - https://www.youtube.com/watch?v=Bm96RqNGbGo
    - https://www.youtube.com/watch?v=j6VSAsKAj98
- ASCII (extended) diagrams
    - https://asciiflow.com/
bsb-lookup 0.0.6
Lookup and enrich Australian BSBs
Requires Python: >=3.8.1

# 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)
![downloads](https://static.pepy.tech/badge/bsb-lookup)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

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)
- [Background](#background)
- [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")

print(result)

# >>> 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,
# ... )

```

## Background
A BSB, or Bank State Branch number, is a six-digit code used to identify the specific branch of an Australian bank or financial institution. The BSB is normally used in association with the account number system used by each financial institution.

<img width="400" alt="image" src="https://github.com/ilankessler/bsb-lookup/assets/11990626/e026f52e-5e0b-43a5-b124-bfa65d84f3f1">

## 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

---

**Sponsored by Refundid the Best Returns Portal** - Streamline your retail returns with [Refundid](https://refundid.com/au), Australia's leading returns portal for retailers.