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
Repository
Easy to use progress bars for Python
Basic Info
Statistics
- Stars: 1,423
- Watchers: 17
- Forks: 179
- Open Issues: 34
- Releases: 0
Metadata Files
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
- Website: https://easygit.app
- Repositories: 1
- Profile: https://github.com/verigak
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
Top Committers
| Name | 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
- Homepage: https://github.com/verigak/progress/
- Documentation: https://progress.readthedocs.io/
- License: isc
-
Latest release: 1.6.1
published about 1 year ago
Rankings
Maintainers (1)
alpine-v3.18: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r3
published about 3 years ago
Rankings
alpine-v3.18: py3-progress-pyc
Precompiled Python bytecode for py3-progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r3
published about 3 years ago
Rankings
alpine-v3.12: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.5-r0
published over 6 years ago
Rankings
Maintainers (1)
alpine-v3.13: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.5-r0
published over 6 years ago
Rankings
Maintainers (1)
alpine-v3.15: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r0
published almost 5 years ago
Rankings
alpine-v3.16: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r1
published over 4 years ago
Rankings
alpine-edge: py3-progress-pyc
Precompiled Python bytecode for py3-progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-edge: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.14: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.5-r2
published about 5 years ago
Rankings
alpine-v3.17: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r1
published over 4 years ago
Rankings
conda-forge.org: progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.3
published almost 4 years ago
Rankings
anaconda.org: progress
progress is a lightweight and easy-to-use Python library for displaying progress indicators in console applications.
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6.1
published 12 months ago
Rankings
alpine-v3.19: py3-progress-pyc
Precompiled Python bytecode for py3-progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r3
published about 3 years ago
Rankings
alpine-v3.21: py3-progress-pyc
Precompiled Python bytecode for py3-progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.20: py3-progress-pyc
Precompiled Python bytecode for py3-progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.21: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.22: py3-progress-pyc
Precompiled Python bytecode for py3-progress
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.20: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.22: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r4
published about 2 years ago
Rankings
alpine-v3.19: py3-progress
Easy to use progress bars for Python3
- Homepage: https://github.com/verigak/progress
- License: ISC
-
Latest release: 1.6-r3
published about 3 years ago