manrajgrover/halo

Synchronous spinner

Open

#47 opened on Feb 16, 2018

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (149 forks)github user discovery
hacktoberfestup-for-grabs

Repository metrics

Stars
 (3,022 stars)
PR merge metrics
 (PR metrics pending)

Description

Support synchronous spinners which switch frames upon explicit request from a working thread like.

with Halo(spinner='dots') as spinner:
  for f in files_to_load():
    spinner.next(text="Loading %s" %f) # or .step(), or .tick(), or…
    do_load_file(f)

This can (as far as I understand) be achieved with .frame() but isn't as concise as the above. Possibly don't render new frame more often than interval.

Contributor guide

Research direction
Implement a synchronous method like `next()` in the Halo class that advances the spinner frame manually, while respecting the frame interval. Look at the existing `frame()` method and the spinner's internal state.
Tech stack
python
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70