Metadata-Version: 2.1
Name: tqdl
Version: 0.0.2
Summary: requests-based file downloads with tqdm progress bars
Home-page: https://github.com/shaypal5/tqdl
Author: Shay Palachy
Author-email: shay.palachy@gmail.com
License: MIT
Description: tqdl ⋙
        ######
        
        |PyPI-Status| |Downloads| |PyPI-Versions| |Build-Status| |Codecov| |Codefactor| |LICENCE|
        
        ``requests``-based file downloads with ``tqdm`` progress bars.   
        
        .. code-block:: python
        
          from tqdl import download
          download(file_url, target_file_path)
           19%|█▊        | 20.5M/110M [00:06<00:29, 2.98MiB/s]
        
        .. contents::
        
        .. section-numbering::
        
        
        Installation
        ============
        
        .. code-block:: bash
        
          pip install tqdl
        
        
        Contributing
        ============
        
        Package author and current maintainer is `Shay Palachy <http://www.shaypalachy.com/>`_ (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.
        
        Installing for development
        ----------------------------
        
        Clone:
        
        .. code-block:: bash
        
          git clone git@github.com:shaypal5/tqdl.git
        
        
        Install in development mode, including test dependencies:
        
        .. code-block:: bash
        
          cd tqdl
          pip install -e '.[test]'
        
        
        Running the tests
        -----------------
        
        To run the tests use:
        
        .. code-block:: bash
        
          cd tqdl
          pytest
        
        
        Adding documentation
        --------------------
        
        The project is documented using the `numpy docstring conventions`_, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings. When documenting code you add to this project, follow `these conventions`_.
        
        .. _`numpy docstring conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
        .. _`these conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
        
        Additionally, if you update this ``README.rst`` file,  use ``python setup.py checkdocs`` to validate it compiles.
        
        
        Credits
        =======
        
        Created by `Shay Palachy <http://www.shaypalachy.com/>`_ (shay.palachy@gmail.com).
        
        Based on a `stackoverflow answer by user leovp <https://stackoverflow.com>`_.
        
        
        .. |PyPI-Status| image:: https://img.shields.io/pypi/v/tqdl.svg
          :target: https://pypi.python.org/pypi/tqdl
        
        .. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/tqdl.svg
           :target: https://pypi.python.org/pypi/tqdl
        
        .. |Build-Status| image:: https://travis-ci.org/shaypal5/tqdl.svg?branch=master
           :target: https://travis-ci.org/shaypal5/tqdl
        
        .. |LICENCE| image:: https://img.shields.io/badge/License-MIT-yellow.svg
           :target: https://github.com/shaypal5/tqdl/blob/master/LICENSE
        
        .. |Codecov| image:: https://codecov.io/github/shaypal5/tqdl/coverage.svg?branch=master
           :target: https://codecov.io/github/shaypal5/tqdl?branch=master
        
        .. |Codacy| image:: https://api.codacy.com/project/badge/Grade/99e79faee7454a13a0e60219c32015ae
           :alt: Codacy Badge
           :target: https://app.codacy.com/app/shaypal5/tqdl?utm_source=github.com&utm_medium=referral&utm_content=shaypal5/tqdl&utm_campaign=Badge_Grade_Dashboard
        
        .. |Requirements| image:: https://requires.io/github/shaypal5/tqdl/requirements.svg?branch=master
           :target: https://requires.io/github/shaypal5/tqdl/requirements/?branch=master
           :alt: Requirements Status
             
        .. |Codefactor| image:: https://www.codefactor.io/repository/github/shaypal5/tqdl/badge?style=plastic
           :target: https://www.codefactor.io/repository/github/shaypal5/tqdl
           :alt: Codefactor code quality
        
        .. |Downloads| image:: https://pepy.tech/badge/tqdl
           :target: https://pepy.tech/project/tqdl
           :alt: PePy stats
        
        .. .. test pypi
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
Provides-Extra: test
