Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/askn/progress
[==..] Progress bar for Crystal Programming Language
https://github.com/askn/progress
crystal progress-bar
Last synced: 27 days ago
JSON representation
[==..] Progress bar for Crystal Programming Language
- Host: GitHub
- URL: https://github.com/askn/progress
- Owner: askn
- License: mit
- Created: 2015-12-26T16:35:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T19:54:44.000Z (8 months ago)
- Last Synced: 2024-11-07T21:41:57.227Z (about 1 month ago)
- Topics: crystal, progress-bar
- Language: Crystal
- Homepage:
- Size: 478 KB
- Stars: 134
- Watchers: 8
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - progress - [==..] Progress bar (Cli Utils)
README
# **[==..]** progress
Progress bar for Crystal
![Colored Progress Bar](/images/colors_progress.gif)
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
progress:
github: askn/progress
```## Usage
```crystal
require "progress"bar = ProgressBar.new
bar.width = 40until bar.done?
bar.inc
sleep 0.1
end
```![Simple Progress Bar](/images/simple_progress.gif)
## Functions
`inc`: a step increase to current tick and print
`tick(n)`: add to current tick and print
`set(n)`: Set current tick and print
`done`: finish and print
`done?`: is done ?
`current`: current tick number
`percent`: completion percentage
## Options
`complete`: completion character
`incomplete`: completion character
`step`: default 1
`width`: the displayed width of the progress bar (default: 100)
`total`: total ticks (default: 100)
`use_stdout`: if true, write progress bar to standard output, otherwise standard error (default: false)
## TODO
- [ ] Bar format
- [ ] Multiple bar
- [ ] Max bar width## Contributing
1. Fork it ( https://github.com/askn/progress/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request## Contributors
- [askn](https://github.com/askn) Aşkın Gedik - creator, maintainer