bash-spinner

Display a small progress spinner in bash while running your commands with optional message.

https://github.com/developerstoolbox/bash-spinner

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary

Keywords

progress-spinner spinner wolfsoftware
Last synced: 4 months ago · JSON representation ·

Repository

Display a small progress spinner in bash while running your commands with optional message.

Basic Info
  • Host: GitHub
  • Owner: DevelopersToolbox
  • License: mit
  • Language: Shell
  • Default Branch: master
  • Homepage:
  • Size: 170 KB
Statistics
  • Stars: 8
  • Watchers: 2
  • Forks: 3
  • Open Issues: 3
  • Releases: 1
Topics
progress-spinner spinner wolfsoftware
Created almost 5 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

DevelopersToolbox logo
Github Build Status License Created
Release Released Commits since release

Overview

Display a small progress spinner in bash while running your commands with optional message.

This can be used for anything that takes time.

Simple (Static) Example

This example passes a static string to startspinner which remains in place until stopspinner is called.

```shell source spinner.sh

start_spinner "This is my cool spinner message" sleep 10

stop_spinner ```

Dynamic Example

This example passes a command to startspinnereval which will be re-evaluated each time the spinner is drawn until stop_spinner is called.

```shell source spinner.sh

startspinnereval 'cat log | tail -1'

for i in {1..10}; do echo "Iteration number ${i}" >> log sleep 1 done

stop_spinner ```

Config

You can set an environment value called SPINNER_DELAY to change the default (0.25 seconds) delay used when drawing the spinner.


Owner

  • Name: Developers Toolbox
  • Login: DevelopersToolbox
  • Kind: organization
  • Email: github@wolfsoftware.com
  • Location: United Kingdom

A selection of tools to help developers. Created by Wolf Software.

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: Bash Spinner
abstract: Display a small progress spinner in bash while running your commands with optional message.
type: software
version: 0.1.0
date-released: 2024-06-04
repository-code: https://github.com/DevelopersToolbox/bash-spinner
keywords:
  - "Wolf Software"
  - "Software"
license: MIT
authors:
  - family-names: "Wolf"
    orcid: "https://orcid.org/0009-0007-0983-2072"

GitHub Events

Total
  • Watch event: 1
  • Delete event: 64
  • Issue comment event: 123
  • Push event: 118
  • Pull request review event: 105
  • Pull request event: 123
  • Create event: 66
Last Year
  • Watch event: 1
  • Delete event: 64
  • Issue comment event: 123
  • Push event: 118
  • Pull request review event: 105
  • Pull request event: 123
  • Create event: 66

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 2
  • Total pull requests: 126
  • Average time to close issues: 3 days
  • Average time to close pull requests: about 16 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 8.0
  • Average comments per pull request: 1.88
  • Merged pull requests: 118
  • Bot issues: 1
  • Bot pull requests: 125
Past Year
  • Issues: 1
  • Pull requests: 107
  • Average time to close issues: 1 minute
  • Average time to close pull requests: about 19 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.89
  • Merged pull requests: 99
  • Bot issues: 1
  • Bot pull requests: 107
Top Authors
Issue Authors
  • emilheunecke (1)
Pull Request Authors
  • dependabot[bot] (172)
  • emilheunecke (1)
Top Labels
Issue Labels
Pull Request Labels
dependabot: dependencies (172) dependabot: ecosystem : github actions (172) dependabot: auto approve (161) dependabot: auto merge (161) dependabot: manual merge (6)

Dependencies

.github/workflows/cicd.yml actions
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
.github/workflows/citation-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • citation-file-format/cffconvert-github-action 4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 composite
  • ruby/setup-ruby 78c01b705fd9d5ad960d432d3a0cfa341d50e410 composite
.github/workflows/delete-old-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • Mattraks/delete-workflow-runs 39f0bbed25d76b34de5594dceab824811479e5de composite
.github/workflows/dependabot.yml actions
  • dependabot/fetch-metadata 5e5f99653a5b510e8555840e80cbf1514ad4af38 composite
.github/workflows/document-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-node 60edb5dd545a775178f52524783378180af0d1f8 composite
  • ruby/setup-ruby 78c01b705fd9d5ad960d432d3a0cfa341d50e410 composite
.github/workflows/generate-release.yml actions
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • softprops/action-gh-release 69320dbe05506a9a39fc8ae11030b214ec2d1f87 composite
.github/workflows/generate-test-release.yml actions
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • softprops/action-gh-release 69320dbe05506a9a39fc8ae11030b214ec2d1f87 composite
.github/workflows/greetings.yml actions
  • actions/first-interaction 34f15e814fe48ac9312ccf29db4e74fa767cbab7 composite
.github/workflows/purge-deprecated-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • otto-de/purge-deprecated-workflow-runs 31a4e821d43e9a354cbd65845922c76e4b4b3633 composite
.github/workflows/repository-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-go cdcb36043654635271a94b9a6d1392de5bb323a7 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
.github/workflows/security-hardening.yml actions
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • zgosalvez/github-actions-ensure-sha-pinned-actions 76d1d8e0b075d7190b5d59b86da91c7bdbcc99b2 composite
.github/workflows/stale.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite