{ "info": { "author": "Shay Palachy", "author_email": "shay.palachy@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "tqdl \u22d9\n######\n\n|PyPI-Status| |PyPI-Versions| |Build-Status| |Codecov| |LICENCE|\n\n``requests``-based file downloads with ``tqdm`` progress bars. \n\n.. code-block:: python\n\n from tqdl import download\n download(file_url, target_file_path)\n 19%|\u2588\u258a | 20.5M/110M [00:06<00:29, 2.98MiB/s]\n\n.. contents::\n\n.. section-numbering::\n\n\nInstallation\n============\n\n.. code-block:: bash\n\n pip install tqdl\n\n\nFeatures\n========\n\n* Simple and straightforward API.\n* Installable from PyPI with ``pip install tqdl``.\n* `Tested on TravisCI `_ against Linux, Windows and macOS, and Python versions 3.5 through 3.7.\n* The name - \u062a\u0642\u062f\u0651\u0644 - can be traslated as \"get ahead\", which is awesome. \n\n\nUse\n===\n\n``tqdl`` contains a single funcion, aptly named download, which you can use to download files with a nice progress bar by providing it with a URL and a file path. Obviously, this is only useful for downloads of large files, and where you cae about showing the user (of your code/script/whatever) the progress of the ongoing download.\n\nHere is a very straightforward example:\n\n.. code-block:: python\n\n from tqdl import download\n download(file_url, target_file_path)\n 19%|\u2588\u258a | 20.5M/110M [00:06<00:29, 2.98MiB/s]\n\n\nContributing\n============\n\nPackage author and current maintainer is `Shay Palachy `_ (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.\n\nInstalling for development\n----------------------------\n\nClone:\n\n.. code-block:: bash\n\n git clone git@github.com:shaypal5/tqdl.git\n\n\nInstall in development mode, including test dependencies:\n\n.. code-block:: bash\n\n cd tqdl\n pip install -e '.[test]'\n\n\nRunning the tests\n-----------------\n\nTo run the tests use:\n\n.. code-block:: bash\n\n cd tqdl\n pytest\n\n\nAdding documentation\n--------------------\n\nThe 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`_.\n\n.. _`numpy docstring conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt\n.. _`these conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt\n\nAdditionally, if you update this ``README.rst`` file, use ``python setup.py checkdocs`` to validate it compiles.\n\n\nCredits\n=======\n\nCreated by `Shay Palachy `_ (shay.palachy@gmail.com).\n\nBased on a `stackoverflow answer by user leovp `_.\n\n\n.. |PyPI-Status| image:: https://img.shields.io/pypi/v/tqdl.svg\n :target: https://pypi.python.org/pypi/tqdl\n\n.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/tqdl.svg\n :target: https://pypi.python.org/pypi/tqdl\n\n.. |Build-Status| image:: https://travis-ci.org/shaypal5/tqdl.svg?branch=master\n :target: https://travis-ci.org/shaypal5/tqdl\n\n.. |LICENCE| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://github.com/shaypal5/tqdl/blob/master/LICENSE\n\n.. |Codecov| image:: https://codecov.io/github/shaypal5/tqdl/coverage.svg?branch=master\n :target: https://codecov.io/github/shaypal5/tqdl?branch=master\n\n.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/99e79faee7454a13a0e60219c32015ae\n :alt: Codacy Badge\n :target: https://app.codacy.com/app/shaypal5/tqdl?utm_source=github.com&utm_medium=referral&utm_content=shaypal5/tqdl&utm_campaign=Badge_Grade_Dashboard\n\n.. |Requirements| image:: https://requires.io/github/shaypal5/tqdl/requirements.svg?branch=master\n :target: https://requires.io/github/shaypal5/tqdl/requirements/?branch=master\n :alt: Requirements Status\n\n.. |Codefactor| image:: https://www.codefactor.io/repository/github/shaypal5/tqdl/badge?style=plastic\n :target: https://www.codefactor.io/repository/github/shaypal5/tqdl\n :alt: Codefactor code quality\n\n.. |Downloads| image:: https://pepy.tech/badge/tqdl\n :target: https://pepy.tech/project/tqdl\n :alt: PePy stats\n\n.. .. test pypi\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/shaypal5/tqdl", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "tqdl", "package_url": "https://pypi.org/project/tqdl/", "platform": "", "project_url": "https://pypi.org/project/tqdl/", "project_urls": { "Homepage": "https://github.com/shaypal5/tqdl" }, "release_url": "https://pypi.org/project/tqdl/0.0.4/", "requires_dist": [ "requests", "tqdm", "pytest; extra == 'test'", "coverage; extra == 'test'", "pytest-cov; extra == 'test'", "collective.checkdocs; extra == 'test'", "pygments; extra == 'test'", "requests; extra == 'test'", "tqdm; extra == 'test'" ], "requires_python": ">=3.5", "summary": "requests-based file downloads with tqdm progress bars", "version": "0.0.4", "yanked": false, "yanked_reason": null }, "last_serial": 6037182, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "5bd1192e775c595ec2c727bef3bbf113", "sha256": "3446f72f5400cdbde514a229e5f6564aa674dd083622a70c5734806fe409af9c" }, "downloads": -1, "filename": "tqdl-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5bd1192e775c595ec2c727bef3bbf113", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 4308, "upload_time": "2019-10-27T14:00:08", "upload_time_iso_8601": "2019-10-27T14:00:08.791674Z", "url": "https://files.pythonhosted.org/packages/a4/7d/d921d8c9e277b7a957e8266af5d3269c47b113da8b660f11df8de35183b4/tqdl-0.0.2-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "aa9962cb078f16f9c355ca2b526db5b2", "sha256": "0d388916b0105237d3382a0801df398cc29dfe00b9a2f30565320c8dfc9e87de" }, "downloads": -1, "filename": "tqdl-0.0.2.tar.gz", "has_sig": false, "md5_digest": "aa9962cb078f16f9c355ca2b526db5b2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 19653, "upload_time": "2019-10-27T14:00:12", "upload_time_iso_8601": "2019-10-27T14:00:12.022003Z", "url": "https://files.pythonhosted.org/packages/e6/7b/9b5194ac155ada0bf1b630601a2b53cd0e36fc3e2d942a2626814383acb0/tqdl-0.0.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "0330aae2c309567a190d4d48edf95226", "sha256": "a8695add50bdf56207247c22454fbc15ac8bf29963d553b5711b192d7888e68e" }, "downloads": -1, "filename": "tqdl-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "0330aae2c309567a190d4d48edf95226", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 4710, "upload_time": "2019-10-27T14:19:04", "upload_time_iso_8601": "2019-10-27T14:19:04.033321Z", "url": "https://files.pythonhosted.org/packages/cf/04/7917e310ce9eba095eafc58481b0c47f5d728001ebb8e1f89efb67e7c07d/tqdl-0.0.3-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "b2d4a825304fac62862fd0a602400bcb", "sha256": "a51f823252c6f69985ba02f18e0cf04efcda2aa5cce4262932696b2e7efe8b30" }, "downloads": -1, "filename": "tqdl-0.0.3.tar.gz", "has_sig": false, "md5_digest": "b2d4a825304fac62862fd0a602400bcb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 20118, "upload_time": "2019-10-27T14:19:05", "upload_time_iso_8601": "2019-10-27T14:19:05.703497Z", "url": "https://files.pythonhosted.org/packages/e9/33/13ab30cc09bb73594f191953845df74536c3adbf3b820aa01885350a1eff/tqdl-0.0.3.tar.gz", "yanked": false, "yanked_reason": null } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "a9f3432ac0a0ecc6393cf960c604e3df", "sha256": "a385e300a0a02903b266c1b737486c9580cedafa6de9a0d686cb02de43a2e0a4" }, "downloads": -1, "filename": "tqdl-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "a9f3432ac0a0ecc6393cf960c604e3df", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 4730, "upload_time": "2019-10-27T14:24:09", "upload_time_iso_8601": "2019-10-27T14:24:09.149395Z", "url": "https://files.pythonhosted.org/packages/a1/72/75ef3450112c6f82ee80e58a1c7eafac2e355790f81c941f2ea9a775951b/tqdl-0.0.4-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "5e497567292b702729def771b8d27552", "sha256": "60d95cf53e9f3d9617d0d5b54585d6bd6d79ff9dfcfc10965d351b06e7617931" }, "downloads": -1, "filename": "tqdl-0.0.4.tar.gz", "has_sig": false, "md5_digest": "5e497567292b702729def771b8d27552", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 20136, "upload_time": "2019-10-27T14:24:10", "upload_time_iso_8601": "2019-10-27T14:24:10.977725Z", "url": "https://files.pythonhosted.org/packages/b9/e6/7c7b02481932aaa579fb33b8f567b5735b9a1d1b8ba3895d5cbad6faeafc/tqdl-0.0.4.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a9f3432ac0a0ecc6393cf960c604e3df", "sha256": "a385e300a0a02903b266c1b737486c9580cedafa6de9a0d686cb02de43a2e0a4" }, "downloads": -1, "filename": "tqdl-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "a9f3432ac0a0ecc6393cf960c604e3df", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 4730, "upload_time": "2019-10-27T14:24:09", "upload_time_iso_8601": "2019-10-27T14:24:09.149395Z", "url": "https://files.pythonhosted.org/packages/a1/72/75ef3450112c6f82ee80e58a1c7eafac2e355790f81c941f2ea9a775951b/tqdl-0.0.4-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "5e497567292b702729def771b8d27552", "sha256": "60d95cf53e9f3d9617d0d5b54585d6bd6d79ff9dfcfc10965d351b06e7617931" }, "downloads": -1, "filename": "tqdl-0.0.4.tar.gz", "has_sig": false, "md5_digest": "5e497567292b702729def771b8d27552", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 20136, "upload_time": "2019-10-27T14:24:10", "upload_time_iso_8601": "2019-10-27T14:24:10.977725Z", "url": "https://files.pythonhosted.org/packages/b9/e6/7c7b02481932aaa579fb33b8f567b5735b9a1d1b8ba3895d5cbad6faeafc/tqdl-0.0.4.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }