New Upstream Release - proglog
Ready changes
Summary
Merged new upstream version: 0.1.10 (was: 0.1.9).
Resulting package
Built on 2023-01-15T03:36 (took 3m4s)
The resulting binary packages can be installed (if you have the apt repository enabled) by running one of:
apt install -t fresh-releases python3-proglog
Lintian Result
Diff
diff --git a/LICENCE.txt b/LICENSE
old mode 100755
new mode 100644
similarity index 86%
rename from LICENCE.txt
rename to LICENSE
index f7a40d9..ace49c0
--- a/LICENCE.txt
+++ b/LICENSE
@@ -1,8 +1,4 @@
-
-The MIT License (MIT)
-[OSI Approved License]
-
-The MIT License (MIT)
+MIT License
Copyright (c) 2017 Edinburgh Genome Foundry
@@ -13,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/PKG-INFO b/PKG-INFO
index db9a00a..9bede5e 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,31 +1,33 @@
-Metadata-Version: 1.0
+Metadata-Version: 2.1
Name: proglog
-Version: 0.1.9
+Version: 0.1.10
Summary: Log and progress bar manager for console, notebooks, web...
-Home-page: UNKNOWN
Author: Zulko
-Author-email: UNKNOWN
-License: MIT - copyright Edinburgh Genome Foundry
-Description: Proglog
- ===================
- Proglog is a progress logging system for Python. It allows to build complex
- libraries while giving the user control on the management of logs, callbacks and progress bars.
-
-
- Infos
- -----
-
- **PIP installation:**
-
- .. code:: bash
-
- pip install proglog
-
- **Github Page**
-
- `<https://github.com/Edinburgh-Genome-Foundry/Proglog>`_
-
- **License:** MIT, Copyright Edinburgh Genome Foundry
-
+License: MIT
Keywords: logger log progress bar
Platform: UNKNOWN
+License-File: LICENSE
+
+Proglog
+=======
+
+Proglog is a progress logging system for Python. It allows to build complex
+libraries while giving the user control on the management of logs, callbacks and progress bars.
+
+
+Infos
+-----
+
+**PIP installation:**
+
+.. code:: bash
+
+ pip install proglog
+
+**Github Page**
+
+`<https://github.com/Edinburgh-Genome-Foundry/Proglog>`_
+
+**License:** MIT, Copyright Edinburgh Genome Foundry
+
+
diff --git a/README.rst b/README.rst
index 41989a7..f3133b1 100755
--- a/README.rst
+++ b/README.rst
@@ -5,14 +5,25 @@
<br /><br />
</p>
+.. image:: https://github.com/Edinburgh-Genome-Foundry/Proglog/actions/workflows/build.yml/badge.svg
+ :target: https://github.com/Edinburgh-Genome-Foundry/Proglog/actions/workflows/build.yml
+ :alt: GitHub CI build status
+
+.. image:: https://coveralls.io/repos/github/Edinburgh-Genome-Foundry/Proglog/badge.svg?branch=master
+ :target: https://coveralls.io/github/Edinburgh-Genome-Foundry/Proglog?branch=master
+
Proglog is a progress logging system for Python. It allows to build complex
-libraries while giving the user control on the management of logs, callbacks and progress bars.
+libraries while giving your users control over logs, callbacks and progress bars.
+
+**What problems does it solve ?**
+
+Libraries like `tqdm <https://github.com/noamraph/tqdm>`_ or `progress <https://github.com/verigak/progress/>`_ are great for quickly adding progress bars to your scripts, but become difficult to manage when building larger projects.
-**What problems does it solve ?** Libraries like `tqdm <https://github.com/noamraph/tqdm>`_ or `progress <https://github.com/verigak/progress/>`_ are great for quickly adding progress bars to your scripts, but become difficult to manage when building larger projects.
+For instance, you will need to write different code depending on whether you are displaying the progress in a console, a Jupyter notebook, or a webpage.
-For instance, you will need to write different code depending on whether you are displaying the progress in a console, a Jupyter notebook, or a website.
+Sometimes a single program may have to handle many logs and progress bars coming from different subprograms and libraries, at which case you may want to let the final user decide which progress bars they want to display or to mute, even when these progress bars are handled deep down in your program.
-Sometimes you need to channel the progress logs of different components into a same logger, at which case you may also let the final user choose which progress bars they want to display or to mute, even when these are handled deep down in your programs.
+For instance if your program 1 calls a program 2 and program 3 (possibly from other libraries), you may want to be able to silence the progress bars of routine 2, or to only show the progress bars of routine 1. As long as all routines use Proglog, this will be easy to do.
.. raw:: html
@@ -25,22 +36,21 @@ You may also want to log more than just progress bars, have specific callback fo
Usage
--------
+-----
Assume that you are writing a library called ``my_library`` in which you define a routine as follows:
.. code:: python
- import time # for simulating computing time
- from proglog import TqdmProgressBarLogger
+ import time # for simulating computing time
+ from proglog import default_bar_logger
- def my_routine(iterations=10, logger='bars'):
+ def my_routine(iterations=10, logger='bar'):
"""Run several loops to showcase Proglog."""
- if logger == 'bars':
- logger = TqdmProgressBarLogger()
+ logger = default_bar_logger(logger) # shorthand to generate a bar logger
for i in logger.iter_bar(iteration=range(iterations)):
for j in logger.iter_bar(animal=['dog', 'cat', 'rat', 'duck']):
- time.sleep(0.1) # Simulate some computing time
+ time.sleep(0.1) # simulate some computing time
Now when the library users run a program in the console, they will get a console progress bar:
@@ -77,8 +87,7 @@ If the user wishes to turn off all progress bars:
.. code:: python
from my_library import my_routine
- from proglog import MuteProgressBarLogger
- my_routine(logger=MuteProgressBarLogger())
+ my_routine(logger=None)
If the user is running the routine on a web server and would want to attach the
data to an asynchronous Python-RQ job, all they need is yet a different logger:
@@ -138,7 +147,7 @@ For more complex customization, such as adding callback functions which will be
logger = MyBarLogger()
my_routine(logger=logger)
-When writing libraries which all log progress and may depend on each other, simply pass the Proglog logger from one program to its dependencies, to obtain one logger keeping track of all progress across libraries at once: (this implies that not two librairies use the same variables or loop names, which can be avoided by attributing prefixes to these names):
+When writing libraries which all log progress and may depend on each other, simply pass the Proglog logger from one program to its dependencies, to obtain one logger keeping track of all progress across libraries at once:
.. raw:: html
@@ -146,37 +155,49 @@ When writing libraries which all log progress and may depend on each other, simp
<img src="https://raw.githubusercontent.com/Edinburgh-Genome-Foundry/Proglog/master/docs/loggers_schema.png" width="650">
</p>
+Note that this implies that not two libraries use the same variables or loop names, which can be avoided by attributing prefixes to these names:
+
+.. code:: python
+
+ for i in logger.iter_bar(iteration=range(iterations), bar_prefix='libraryname_'):
+ ...
+
Installation
--------------
+------------
+
+You can install Proglog through PIP:
+
+.. code:: shell
+
+ pip install proglog
-You can install Proglog through PIP
+Alternatively, you can unzip the sources in a folder and type:
.. code:: shell
- sudo pip install proglog
+ python setup.py install
-Alternatively, you can unzip the sources in a folder and type
+To use the ``tqdm`` notebook-style progress bars you need to install iwidgets:
.. code:: shell
- sudo python setup.py install
+ pip install ipywidgets
-To use the ``tqdm`` notebook-style progress bars you need to install and enable
-iwidgets:
+This `should automatically enable it <https://ipywidgets.readthedocs.io/en/latest/user_install.html>`_; for older versions try:
.. code:: shell
- sudo pip install ipywidgets
- sudo jupyter nbextension enable --py --sys-prefix widgetsnbextension
+ jupyter nbextension enable --py --sys-prefix widgetsnbextension
-Contribute !
+License = MIT
-------------
Proglog is an open-source software originally written at the `Edinburgh Genome Foundry
-<http://www.genomefoundry.io>`_ by `Zulko <https://github.com/Zulko>`_
+<https://www.ed.ac.uk/biology/research/facilities/edinburgh-genome-foundry>`_ by `Zulko <https://github.com/Zulko>`_
and `released on Github <https://github.com/Edinburgh-Genome-Foundry/DnaCauldron>`_ under
-the MIT licence (copyright Edinburgh Genome Foundry).
+the MIT license (Copyright 2017 Edinburgh Genome Foundry).
-Proglog was not written by loggology experts, it *just works* with our projects and we use it a lot. Everyone is welcome to contribute if you find bugs or limitations !
+Proglog was not written by loggology experts, it *just works* with our projects and we use it a lot.
+Everyone is welcome to contribute if you find bugs or limitations !
diff --git a/debian/changelog b/debian/changelog
index 2b57842..a471bb4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+proglog (0.1.10-1) UNRELEASED; urgency=low
+
+ * New upstream release.
+
+ -- Debian Janitor <janitor@jelmer.uk> Sun, 15 Jan 2023 03:33:55 -0000
+
proglog (0.1.9-2) unstable; urgency=medium
* Source-only upload for migration to testing.
diff --git a/proglog.egg-info/PKG-INFO b/proglog.egg-info/PKG-INFO
index db9a00a..9bede5e 100644
--- a/proglog.egg-info/PKG-INFO
+++ b/proglog.egg-info/PKG-INFO
@@ -1,31 +1,33 @@
-Metadata-Version: 1.0
+Metadata-Version: 2.1
Name: proglog
-Version: 0.1.9
+Version: 0.1.10
Summary: Log and progress bar manager for console, notebooks, web...
-Home-page: UNKNOWN
Author: Zulko
-Author-email: UNKNOWN
-License: MIT - copyright Edinburgh Genome Foundry
-Description: Proglog
- ===================
- Proglog is a progress logging system for Python. It allows to build complex
- libraries while giving the user control on the management of logs, callbacks and progress bars.
-
-
- Infos
- -----
-
- **PIP installation:**
-
- .. code:: bash
-
- pip install proglog
-
- **Github Page**
-
- `<https://github.com/Edinburgh-Genome-Foundry/Proglog>`_
-
- **License:** MIT, Copyright Edinburgh Genome Foundry
-
+License: MIT
Keywords: logger log progress bar
Platform: UNKNOWN
+License-File: LICENSE
+
+Proglog
+=======
+
+Proglog is a progress logging system for Python. It allows to build complex
+libraries while giving the user control on the management of logs, callbacks and progress bars.
+
+
+Infos
+-----
+
+**PIP installation:**
+
+.. code:: bash
+
+ pip install proglog
+
+**Github Page**
+
+`<https://github.com/Edinburgh-Genome-Foundry/Proglog>`_
+
+**License:** MIT, Copyright Edinburgh Genome Foundry
+
+
diff --git a/proglog.egg-info/SOURCES.txt b/proglog.egg-info/SOURCES.txt
index 578b922..6643456 100644
--- a/proglog.egg-info/SOURCES.txt
+++ b/proglog.egg-info/SOURCES.txt
@@ -1,4 +1,4 @@
-LICENCE.txt
+LICENSE
MANIFEST.in
README.rst
ez_setup.py
diff --git a/proglog/version.py b/proglog/version.py
index c11f861..569b121 100755
--- a/proglog/version.py
+++ b/proglog/version.py
@@ -1 +1 @@
-__version__ = "0.1.9"
+__version__ = "0.1.10"
diff --git a/pypi-readme.rst b/pypi-readme.rst
index daf3a2b..c473825 100644
--- a/pypi-readme.rst
+++ b/pypi-readme.rst
@@ -1,5 +1,6 @@
Proglog
-===================
+=======
+
Proglog is a progress logging system for Python. It allows to build complex
libraries while giving the user control on the management of logs, callbacks and progress bars.
diff --git a/setup.py b/setup.py
index 56b585b..e7b8748 100755
--- a/setup.py
+++ b/setup.py
@@ -1,16 +1,19 @@
import ez_setup
+
ez_setup.use_setuptools()
from setuptools import setup, find_packages
-exec(open('proglog/version.py').read()) # loads __version__
+exec(open("proglog/version.py").read()) # loads __version__
-setup(name='proglog',
- version=__version__,
- author='Zulko',
- description='Log and progress bar manager for console, notebooks, web...',
- long_description=open('pypi-readme.rst').read(),
- license='MIT - copyright Edinburgh Genome Foundry',
+setup(
+ name="proglog",
+ version=__version__,
+ author="Zulko",
+ description="Log and progress bar manager for console, notebooks, web...",
+ long_description=open("pypi-readme.rst").read(),
+ license="MIT",
keywords="logger log progress bar",
- install_requires=['tqdm'],
- packages= find_packages(exclude='docs'))
+ install_requires=["tqdm"],
+ packages=find_packages(exclude="docs"),
+)
Debdiff
[The following lists of changes regard files as different if they have different names, permissions or owners.]
Files in second set of .debs but not in first
-rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.10.egg-info/PKG-INFO -rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.10.egg-info/dependency_links.txt -rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.10.egg-info/requires.txt -rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.10.egg-info/top_level.txt
Files in first set of .debs but not in second
-rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.9.egg-info/PKG-INFO -rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.9.egg-info/dependency_links.txt -rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.9.egg-info/requires.txt -rw-r--r-- root/root /usr/lib/python3/dist-packages/proglog-0.1.9.egg-info/top_level.txt
No differences were encountered in the control files