Progressive

A customizeable, text-based progress bar generator & library for Arturo

• What does this package do?
• How do I use it?
  • With iterators
  • Custom progress bars
• Option Reference
  • Styles
  • Common options
  • More customization
• License

What does this package do?

This package introduces ultra-customizeable terminal-based progress bars for Arturo. Simply put, whether you want to track the progress through an iteration or create a custom progress bar and play with it yourself, it's supported.

How do I use it?

First import it and then... let's decide how you want to use it.

With iterators

Do you want to use it along with an existing iterator? That's very easy:

import "progressive"!

progressive\loop 1..20 'x [
    processing ~"Current num: |x|"
    pause 200
]

Important
Right now, Progressive supports the following Iterator "overloads":

• loop
• map
• select
• filter

Tip
By calling the magic function processing from inside a progressive iterator, you may pass information which will be displayed above the progress bar (as in: "what is currently being processed?")

Custom progress bars

If you want to create a progress bar object and manipulate it yourself, that's possible too:

import "progressive"!

i: 0
limit: 20
progress: progressive\new limit!

while [i < 20][
    progress\increase 1
    pause 200
    i: i + 1
]

Option Reference

Progressive comes with lots of different options so that you are able to customize your progress bars to your heart's content!

Styles

Common options

More customization

Tip
You may pass any combination of the options above (= that's a lot!) either to an iterator, or when creating a new custom progress bar.
So, this:

progressive\loop .fancy .label:"Doing sth" ...

...is perfectly valid!

License

MIT License

Copyright (c) 2024 Yanis Zafirópulos

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.