Metadata-Version: 2.1
Name: countdown-cli
Version: 1.0.1
Summary: Terminal program to display countdown timer
Home-page: https://github.com/treyhunner/countdown-cli
License: MIT
Author: Trey Hunner
Author-email: trey@treyhunner.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=8.0.1,<9.0.0)
Project-URL: Changelog, https://github.com/treyhunner/countdown-cli/releases
Project-URL: Documentation, https://countdown-cli.readthedocs.io
Project-URL: Repository, https://github.com/treyhunner/countdown-cli
Description-Content-Type: text/x-rst

countdown-cli
=============

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

|Read the Docs| |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
.. |Read the Docs| image:: https://img.shields.io/readthedocs/countdown-cli/latest.svg?label=Read%20the%20Docs
   :target: https://countdown-cli.readthedocs.io/
   :alt: Read the documentation at https://countdown-cli.readthedocs.io/
.. |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://countdown-cli.readthedocs.io/en/latest/_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)


Features
--------

* Full-screen countdown timer, centered in the terminal window
* Command-line interface for Linux/Mac/Windows

|32:53|

|14:57|

.. |32:53| image:: https://countdown-cli.readthedocs.io/en/latest/_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://countdown-cli.readthedocs.io/en/latest/_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.7+


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

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

.. code:: console

   $ python3 -m pip install countdown-cli


Usage
-----

Please see the `Command-line Reference <Usage_>`_ for details.


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.


Credits
-------

This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.

.. _Python Morsels: https://www.pythonmorsels.com
.. _@cjolowicz: https://github.com/cjolowicz
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/project/countdown-cli/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/treyhunner/countdown-cli/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://countdown-cli.readthedocs.io/en/latest/usage.html

