countdown-cli


Namecountdown-cli JSON
Version 2.0.0 PyPI version JSON
download
home_pageNone
SummaryTerminal program to display countdown timer
upload_time2025-11-08 04:52:22
maintainerNone
docs_urlNone
authorTrey Hunner
requires_python>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            countdown-cli
=============

|PyPI| |Status| |Python Version| |License|

|Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/countdown-cli.svg
   :target: https://pypi.org/project/countdown-cli/
   :alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/countdown-cli.svg
   :target: https://pypi.org/project/countdown-cli/
   :alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/countdown-cli
   :target: https://pypi.org/project/countdown-cli
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/countdown-cli
   :target: https://opensource.org/licenses/MIT
   :alt: License
.. |Tests| image:: https://github.com/treyhunner/countdown-cli/workflows/Tests/badge.svg
   :target: https://github.com/treyhunner/countdown-cli/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/treyhunner/countdown-cli/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/treyhunner/countdown-cli
   :alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black

This project is based on a `Python Morsels`_ exercise for a command-line countdown timer.
If you're working on that exercise right now, please **don't look at the source code** for this. 😉

|Logo|

.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/python-morsels-logo.png
   :target: https://www.pythonmorsels.com
   :width: 400
   :alt: an adorable snake taking a bite out of a cookie with the words Python Morsels next to it (Python Morsels logo)

Wondering how this package works?
**Don't look at the source code just yet!**
Instead, try implementing this package with the `Python Morsels "countdown" exercise <https://www.pythonmorsels.com/exercises/fc3be8467c634f978eae0c315f5677d1/>`_!


Features
--------

- Full-screen countdown timer, centered in the terminal window
- Responsive timer size based on terminal window width/height
- Command-line interface for Linux/Mac/Windows
- Pause/resume with ``p``, ``k``, ``Space``, or ``Enter``
- Add / remove time with ``+`` or ``-``

|32:53|

|14:57|

.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/3253.png
   :width: 500
   :alt: 32:53 shown in large letters in center of an xterm window (black background with white text)

.. |14:57| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/1457.png
   :width: 500
   :alt: 14:57 shown in large letters in center of terminal window (light background with darker text)


Requirements
------------

- Python 3.10+


Installation
------------

You can install **countdown-cli** via uv_ from PyPI_:

.. code:: console

   $ uv tool install countdown-cli


Contributing
------------

Contributions are very welcome.
To learn more, see the `Contributor Guide`_.


License
-------

Distributed under the terms of the `MIT license`_,
**countdown-cli** is free and open source software.


Issues
------

If you encounter any problems,
please `file an issue`_ along with a detailed description.


.. _Python Morsels: https://www.pythonmorsels.com
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/project/countdown-cli/
.. _file an issue: https://github.com/treyhunner/countdown-cli/issues
.. _uv: https://docs.astral.sh/uv/concepts/tools/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "countdown-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Trey Hunner",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/dd/e6/383b1170fb133b23f43b9bd8a86ec2b13b4d60b0e2690d35e65a7af4ec73/countdown_cli-2.0.0.tar.gz",
    "platform": null,
    "description": "countdown-cli\n=============\n\n|PyPI| |Status| |Python Version| |License|\n\n|Tests| |Codecov|\n\n|pre-commit| |Black|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/countdown-cli.svg\n   :target: https://pypi.org/project/countdown-cli/\n   :alt: PyPI\n.. |Status| image:: https://img.shields.io/pypi/status/countdown-cli.svg\n   :target: https://pypi.org/project/countdown-cli/\n   :alt: Status\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/countdown-cli\n   :target: https://pypi.org/project/countdown-cli\n   :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/countdown-cli\n   :target: https://opensource.org/licenses/MIT\n   :alt: License\n.. |Tests| image:: https://github.com/treyhunner/countdown-cli/workflows/Tests/badge.svg\n   :target: https://github.com/treyhunner/countdown-cli/actions?workflow=Tests\n   :alt: Tests\n.. |Codecov| image:: https://codecov.io/gh/treyhunner/countdown-cli/branch/main/graph/badge.svg\n   :target: https://codecov.io/gh/treyhunner/countdown-cli\n   :alt: Codecov\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n   :target: https://github.com/pre-commit/pre-commit\n   :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n   :alt: Black\n\nThis project is based on a `Python Morsels`_ exercise for a command-line countdown timer.\nIf you're working on that exercise right now, please **don't look at the source code** for this. \ud83d\ude09\n\n|Logo|\n\n.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/python-morsels-logo.png\n   :target: https://www.pythonmorsels.com\n   :width: 400\n   :alt: an adorable snake taking a bite out of a cookie with the words Python Morsels next to it (Python Morsels logo)\n\nWondering how this package works?\n**Don't look at the source code just yet!**\nInstead, try implementing this package with the `Python Morsels \"countdown\" exercise <https://www.pythonmorsels.com/exercises/fc3be8467c634f978eae0c315f5677d1/>`_!\n\n\nFeatures\n--------\n\n- Full-screen countdown timer, centered in the terminal window\n- Responsive timer size based on terminal window width/height\n- Command-line interface for Linux/Mac/Windows\n- Pause/resume with ``p``, ``k``, ``Space``, or ``Enter``\n- Add / remove time with ``+`` or ``-``\n\n|32:53|\n\n|14:57|\n\n.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/3253.png\n   :width: 500\n   :alt: 32:53 shown in large letters in center of an xterm window (black background with white text)\n\n.. |14:57| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/1457.png\n   :width: 500\n   :alt: 14:57 shown in large letters in center of terminal window (light background with darker text)\n\n\nRequirements\n------------\n\n- Python 3.10+\n\n\nInstallation\n------------\n\nYou can install **countdown-cli** via uv_ from PyPI_:\n\n.. code:: console\n\n   $ uv tool install countdown-cli\n\n\nContributing\n------------\n\nContributions are very welcome.\nTo learn more, see the `Contributor Guide`_.\n\n\nLicense\n-------\n\nDistributed under the terms of the `MIT license`_,\n**countdown-cli** is free and open source software.\n\n\nIssues\n------\n\nIf you encounter any problems,\nplease `file an issue`_ along with a detailed description.\n\n\n.. _Python Morsels: https://www.pythonmorsels.com\n.. _MIT license: https://opensource.org/licenses/MIT\n.. _PyPI: https://pypi.org/project/countdown-cli/\n.. _file an issue: https://github.com/treyhunner/countdown-cli/issues\n.. _uv: https://docs.astral.sh/uv/concepts/tools/\n.. github-only\n.. _Contributor Guide: CONTRIBUTING.rst\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Terminal program to display countdown timer",
    "version": "2.0.0",
    "project_urls": {
        "Changelog": "https://github.com/treyhunner/countdown-cli/releases",
        "homepage": "https://github.com/treyhunner/countdown-cli",
        "repository": "https://github.com/treyhunner/countdown-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d9ffe2b540818983f29e366f7dcb9ef03ba9f8b236a3ae1b392d2bdf721c71e6",
                "md5": "0e04bb77b3a473c759bb403b8dc47af6",
                "sha256": "1bf7dbf2f69181f28999f1256bc6956f8bf9d94e783a2b9ee883538b07bade90"
            },
            "downloads": -1,
            "filename": "countdown_cli-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e04bb77b3a473c759bb403b8dc47af6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10518,
            "upload_time": "2025-11-08T04:52:21",
            "upload_time_iso_8601": "2025-11-08T04:52:21.380652Z",
            "url": "https://files.pythonhosted.org/packages/d9/ff/e2b540818983f29e366f7dcb9ef03ba9f8b236a3ae1b392d2bdf721c71e6/countdown_cli-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "dde6383b1170fb133b23f43b9bd8a86ec2b13b4d60b0e2690d35e65a7af4ec73",
                "md5": "57bbd00cc0130c9fd9a81812a5ca476e",
                "sha256": "9c8ce9a5b1472223c6a1d8008237cb3d8cca96a6409a2640d6f080648a649e38"
            },
            "downloads": -1,
            "filename": "countdown_cli-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "57bbd00cc0130c9fd9a81812a5ca476e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 159082,
            "upload_time": "2025-11-08T04:52:22",
            "upload_time_iso_8601": "2025-11-08T04:52:22.546264Z",
            "url": "https://files.pythonhosted.org/packages/dd/e6/383b1170fb133b23f43b9bd8a86ec2b13b4d60b0e2690d35e65a7af4ec73/countdown_cli-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-08 04:52:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "treyhunner",
    "github_project": "countdown-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "countdown-cli"
}
        
Elapsed time: 2.60416s