progress

Easy to use progress bars for Python

https://github.com/verigak/progress

Science Score: 23.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 18 committers (5.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.6%) to scientific vocabulary

Keywords from Contributors

parsing
Last synced: 10 months ago · JSON representation

Repository

Easy to use progress bars for Python

Basic Info
  • Host: GitHub
  • Owner: verigak
  • License: isc
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 650 KB
Statistics
  • Stars: 1,423
  • Watchers: 17
  • Forks: 179
  • Open Issues: 34
  • Releases: 0
Created about 14 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.rst

Easy progress reporting for Python
==================================

|pypi|

|demo|

.. |pypi| image:: https://img.shields.io/pypi/v/progress.svg
   :target: https://pypi.org/project/progress/
.. |demo| image:: https://raw.github.com/verigak/progress/master/demo.gif
   :alt: Demo

Bars
----

There are 7 progress bars to choose from:

- ``Bar``
- ``ChargingBar``
- ``FillingSquaresBar``
- ``FillingCirclesBar``
- ``IncrementalBar``
- ``PixelBar``
- ``ShadyBar``

To use them, just call ``next`` to advance and ``finish`` to finish:

.. code-block:: python

    from progress.bar import Bar

    bar = Bar('Processing', max=20)
    for i in range(20):
        # Do some work
        bar.next()
    bar.finish()

or use any bar of this class as a context manager:

.. code-block:: python

    from progress.bar import Bar

    with Bar('Processing', max=20) as bar:
        for i in range(20):
            # Do some work
            bar.next()

The result will be a bar like the following: ::

    Processing |#############                   | 42/100

To simplify the common case where the work is done in an iterator, you can
use the ``iter`` method:

.. code-block:: python

    for i in Bar('Processing').iter(it):
        # Do some work

Progress bars are very customizable, you can change their width, their fill
character, their suffix and more:

.. code-block:: python

    bar = Bar('Loading', fill='@', suffix='%(percent)d%%')

This will produce a bar like the following: ::

    Loading |@@@@@@@@@@@@@                   | 42%

You can use a number of template arguments in ``message`` and ``suffix``:

==========  ================================
Name        Value
==========  ================================
index       current value
max         maximum value
remaining   max - index
progress    index / max
percent     progress * 100
avg         simple moving average time per item (in seconds)
elapsed     elapsed time in seconds
elapsed_td  elapsed as a timedelta (useful for printing as a string)
eta         avg * remaining
eta_td      eta as a timedelta (useful for printing as a string)
==========  ================================

Instead of passing all configuration options on instantiation, you can create
your custom subclass:

.. code-block:: python

    class FancyBar(Bar):
        message = 'Loading'
        fill = '*'
        suffix = '%(percent).1f%% - %(eta)ds'

You can also override any of the arguments or create your own:

.. code-block:: python

    class SlowBar(Bar):
        suffix = '%(remaining_hours)d hours remaining'
        @property
        def remaining_hours(self):
            return self.eta // 3600


Spinners
========

For actions with an unknown number of steps you can use a spinner:

.. code-block:: python

    from progress.spinner import Spinner

    spinner = Spinner('Loading ')
    while state != 'FINISHED':
        # Do some work
        spinner.next()

There are 5 predefined spinners:

- ``Spinner``
- ``PieSpinner``
- ``MoonSpinner``
- ``LineSpinner``
- ``PixelSpinner``

Installation
============

Download from PyPi

.. code-block:: shell

    pip install progress


Other
=====

There are a number of other classes available too, please check the source or
subclass one of them to create your own.


License
=======

progress is licensed under ISC

Owner

  • Name: Georgios Verigakis
  • Login: verigak
  • Kind: user

GitHub Events

Total
  • Issues event: 2
  • Watch event: 32
  • Issue comment event: 3
  • Push event: 1
  • Pull request event: 3
  • Fork event: 2
Last Year
  • Issues event: 2
  • Watch event: 32
  • Issue comment event: 3
  • Push event: 1
  • Pull request event: 3
  • Fork event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 64
  • Total Committers: 18
  • Avg Commits per committer: 3.556
  • Development Distribution Score (DDS): 0.344
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Georgios Verigakis v****k@g****m 42
Ben Boeckel m****f@g****m 3
Alex Willmer a****x@m****k 2
Marc Abramowitz m****c@m****m 2
Quentin Pradet q****t@g****m 2
Robert Schütz r****z@s****e 1
Shawn Siefkas s****s@m****m 1
VSS-DEV s****9@y****u 1
Alireza Nourian a****a@g****m 1
Fraser Nevett f****n 1
Gabriel g****g@g****m 1
Scott Noyes s****s@g****m 1
Sindre Johansen s****j@g****m 1
Tobias Gruetzmacher t****t@2****s 1
Toby Fox t****x@g****m 1
aduriseti a****i@g****m 1
Edward Barak e****k@g****m 1
LiamGow l****w@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 64
  • Total pull requests: 41
  • Average time to close issues: 10 months
  • Average time to close pull requests: 5 months
  • Total issue authors: 59
  • Total pull request authors: 34
  • Average comments per issue: 2.72
  • Average comments per pull request: 3.46
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: 10 days
  • Average time to close pull requests: 15 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • danizen (3)
  • skyhiter (2)
  • farchy (2)
  • clintolsen (2)
  • ChaiBapchya (1)
  • dmitry-mukhin (1)
  • xsubject (1)
  • VahedCivil (1)
  • IbrarYunus (1)
  • gabriele-cannizzaro (1)
  • hanss0n (1)
  • bearpaw (1)
  • ItayGolanTaranis (1)
  • sindreij (1)
  • jlec (1)
Pull Request Authors
  • msabramo (3)
  • mathstuf (3)
  • james-duvall (2)
  • Precioussheep (2)
  • snoyes (2)
  • pquentin (2)
  • aduriseti (2)
  • praiskup (2)
  • weigq (1)
  • awiebe (1)
  • frasern (1)
  • I-Doctor (1)
  • Kilo59 (1)
  • farchy (1)
  • seanboothm (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 21
  • Total downloads:
    • pypi 1,433,184 last-month
  • Total docker downloads: 160,398,298
  • Total dependent packages: 188
    (may contain duplicates)
  • Total dependent repositories: 7,052
    (may contain duplicates)
  • Total versions: 38
  • Total maintainers: 2
pypi.org: progress

Easy to use progress bars

  • Versions: 10
  • Dependent Packages: 177
  • Dependent Repositories: 7,034
  • Downloads: 1,433,184 Last month
  • Docker Downloads: 160,398,298
Rankings
Dependent repos count: 0.1%
Dependent packages count: 0.1%
Docker downloads count: 0.3%
Downloads: 0.4%
Average: 1.1%
Stargazers count: 1.8%
Forks count: 3.7%
Maintainers (1)
Last synced: 10 months ago
alpine-v3.18: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 3.7%
Stargazers count: 6.8%
Forks count: 7.9%
Last synced: 10 months ago
alpine-v3.18: py3-progress-pyc

Precompiled Python bytecode for py3-progress

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 3.7%
Stargazers count: 6.8%
Forks count: 7.9%
Last synced: 10 months ago
alpine-v3.12: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Stargazers count: 4.0%
Average: 4.7%
Forks count: 4.9%
Dependent packages count: 10.0%
Maintainers (1)
Last synced: 10 months ago
alpine-v3.13: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Stargazers count: 4.6%
Average: 4.8%
Forks count: 5.4%
Dependent packages count: 9.4%
Maintainers (1)
Last synced: 10 months ago
alpine-v3.15: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Stargazers count: 5.0%
Forks count: 5.6%
Average: 6.8%
Dependent packages count: 16.5%
Last synced: 10 months ago
alpine-v3.16: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Stargazers count: 5.3%
Forks count: 5.8%
Average: 7.4%
Dependent packages count: 18.7%
Last synced: 10 months ago
alpine-edge: py3-progress-pyc

Precompiled Python bytecode for py3-progress

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 7.7%
Stargazers count: 8.6%
Forks count: 9.0%
Dependent packages count: 13.4%
Last synced: 10 months ago
alpine-edge: py3-progress

Easy to use progress bars for Python3

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 7.9%
Stargazers count: 8.3%
Forks count: 8.7%
Dependent packages count: 14.6%
Last synced: 10 months ago
alpine-v3.14: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Stargazers count: 4.6%
Forks count: 5.4%
Average: 7.9%
Dependent packages count: 21.7%
Last synced: 10 months ago
alpine-v3.17: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Stargazers count: 6.7%
Forks count: 7.3%
Average: 8.2%
Dependent packages count: 19.0%
Last synced: 10 months ago
conda-forge.org: progress
  • Versions: 3
  • Dependent Packages: 6
  • Dependent Repositories: 9
Rankings
Dependent packages count: 9.0%
Stargazers count: 11.0%
Average: 11.3%
Dependent repos count: 11.5%
Forks count: 13.5%
Last synced: 10 months ago
anaconda.org: progress

progress is a lightweight and easy-to-use Python library for displaying progress indicators in console applications.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 9
Rankings
Stargazers count: 20.9%
Forks count: 24.3%
Average: 31.2%
Dependent repos count: 38.5%
Dependent packages count: 41.0%
Last synced: 10 months ago
alpine-v3.19: py3-progress-pyc

Precompiled Python bytecode for py3-progress

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.21: py3-progress-pyc

Precompiled Python bytecode for py3-progress

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.20: py3-progress-pyc

Precompiled Python bytecode for py3-progress

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.21: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.22: py3-progress-pyc

Precompiled Python bytecode for py3-progress

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.20: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.22: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago
alpine-v3.19: py3-progress

Easy to use progress bars for Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 10 months ago

Dependencies

setup.py pypi