From 5ac6b2776d679429622e8b25e53bf00cc6d0b96a Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Mon, 25 Apr 2016 22:15:26 +0100 Subject: [PATCH] doc updates, badges: pyversions, doi, licence, github --- README.rst | 38 ++++++++++++++++++++++++++++++-------- RELEASE | 31 +++++++++++++++++++++++++++---- 2 files changed, 57 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index f3ecc4c9..9ddaed75 100644 --- a/README.rst +++ b/README.rst @@ -3,9 +3,13 @@ tqdm ==== -|PyPi Status| |PyPi Downloads| +|PyPi Status| |PyPi Downloads| |PyPi Versions| + |Build Status| |Coverage Status| |Branch Coverage Status| +|DOI URI| |Licence| + + ``tqdm`` (read taqadum, تقدّم) means "progress" in arabic. Instantly make your loops show a smart progress meter - just wrap any @@ -35,7 +39,7 @@ It can also be executed as a module with pipes: 10.0Mit [00:02, 3.58Mit/s] 9999999 -Overhead is low -- about 60ns per iteration (80ns with ``gui=True``), and is +Overhead is low -- about 60ns per iteration (80ns with ``tqdm_gui``), and is unit tested against performance regression. By comparison, the well established `ProgressBar `__ has @@ -65,6 +69,8 @@ Installation Latest pypi stable release ~~~~~~~~~~~~~~~~~~~~~~~~~~ +|PyPi Status| |PyPi Downloads| + .. code:: sh pip install tqdm @@ -72,6 +78,8 @@ Latest pypi stable release Latest development release on github ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +|Github Status| |Github Stars| |Github Forks| + Pull and install in the current directory: .. code:: sh @@ -82,9 +90,8 @@ Pull and install in the current directory: Changelog --------- -The list of all changes is available either on -`Github's Releases `_ -or on crawlers such as +The list of all changes is available either on Github's Releases: +|Github Status| or on crawlers such as `allmychanges.com `_. @@ -120,6 +127,7 @@ Instantiation outside of the loop allows for manual control over ``tqdm()``: for char in pbar: pbar.set_description("Processing %s" % char) + Manual ~~~~~~ @@ -192,6 +200,8 @@ Backing up a large directory? Documentation ------------- +|PyPi Versions| + .. code:: python class tqdm(object): @@ -679,11 +689,12 @@ See the file for more information. -License +Licence ------- -Multiple licences, mostly `MPLv2.0, MIT licences `__. +Open Source (OSI approved): |Licence| +Citation information: |DOI URI| Authors ------- @@ -704,12 +715,23 @@ Authors :target: https://coveralls.io/r/tqdm/tqdm .. |Branch Coverage Status| image:: https://codecov.io/github/tqdm/tqdm/coverage.svg?branch=master :target: https://codecov.io/github/tqdm/tqdm?branch=master +.. |Github Status| image:: https://img.shields.io/github/tag/tqdm/tqdm.svg?maxAge=2592000 + :target: https://github.com/tqdm/tqdm/releases +.. |Github Forks| image:: https://img.shields.io/github/forks/tqdm/tqdm.svg + :target: https://github.com/tqdm/tqdm/network +.. |Github Stars| image:: https://img.shields.io/github/stars/tqdm/tqdm.svg + :target: https://github.com/tqdm/tqdm/stargazers .. |PyPi Status| image:: https://img.shields.io/pypi/v/tqdm.svg :target: https://pypi.python.org/pypi/tqdm .. |PyPi Downloads| image:: https://img.shields.io/pypi/dm/tqdm.svg :target: https://pypi.python.org/pypi/tqdm +.. |PyPi Versions| image:: https://img.shields.io/pypi/pyversions/tqdm.svg + :target: https://pypi.python.org/pypi/tqdm +.. |Licence| image:: https://img.shields.io/pypi/l/tqdm.svg + :target: https://raw.githubusercontent.com/tqdm/tqdm/master/LICENCE +.. |DOI URI| image:: https://zenodo.org/badge/21637/tqdm/tqdm.svg + :target: https://zenodo.org/badge/latestdoi/21637/tqdm/tqdm .. |Screenshot| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm.gif .. |Screenshot-Jupyter1| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-1.gif .. |Screenshot-Jupyter2| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-2.gif .. |Screenshot-Jupyter3| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-3.gif - diff --git a/RELEASE b/RELEASE index 6d61370c..7f6d5b98 100644 --- a/RELEASE +++ b/RELEASE @@ -55,13 +55,20 @@ Check the result by using the following commands: python setup.py make installdev ``` -Secondly, build tqdm into a distributable python package: +Secondly, ensure you bump the version, commit **and** tag. The tag format is +typically `v{major}.{minor}.{patch}`, for example: `v4.4.1`. +The current commit's tag is used in the version checking and generation process. +If the current commit is not tagged appropriately, the version will +display as `v{major}.{minor}.{patch}-{commit_hash}`. + +Finally, build tqdm into a distributable python package: ``` python setup.py make build ``` -This will generate several builds in the `dist/` folder. +This will generate several builds in the `dist/` folder. On non-windows +machines the windows ``exe`` installer may fail to build. This is normal. Finally, upload everything to pypi. This can be done easily using the [twine](https://github.com/pypa/twine) module: @@ -80,5 +87,21 @@ cannot re-upload another with the same version number! getting garbled because of a silent error), you can use the following command to update the metadata: `make pypimeta` or `python setup.py register` -Also, the new release can be added to github by creating a new release -from the web interface. +Also, the new release can (should) be added to `github` by creating a new +release from the web interface, uploading packages from the `dist/` folder +created by `python setup.py make build`. + + +SUMMARY +------- + +1. bump version in `tqdm/_version.py` +2. test (e.g. `python setup.py make alltests`) +3. `git commit` +4. `git push` +5. wait for tests to pass + a) in case of failure, fix and go back to (2) +6. `git tag vM.m.p` +7. `python setup.py make distclean` +8. `python setup.py make build` +9. `python setup.py make pypi`