countdown-cli 1.0.2__tar.gz → 1.0.3__tar.gz

{countdown-cli-1.0.2 → countdown_cli-1.0.3}/PKG-INFO

@@ -1,22 +1,22 @@
 Metadata-Version: 2.1
 Name: countdown-cli
-Version: 1.0.2
+Version: 1.0.3
 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
+Requires-Python: >=3.8.1,<4.0.0
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 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
 
@@ -25,7 +25,7 @@ countdown-cli
 
 |PyPI| |Status| |Python Version| |License|
 
-|Read the Docs| |Tests| |Codecov|
+|Tests| |Codecov|
 
 |pre-commit| |Black|
 
@@ -41,9 +41,6 @@ countdown-cli
 .. |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
@@ -62,11 +59,15 @@ If you're working on that exercise right now, please **don't look at the source
 
 |Logo|
 
-.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/python-morsels-logo.png
+.. |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
 --------
@@ -78,11 +79,11 @@ Features
 
 |14:57|
 
-.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/3253.png
+.. |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/docs/images/1457.png
+.. |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)
 
@@ -103,12 +104,6 @@ You can install *countdown-cli* via pip_ from PyPI_:
    $ python3 -m pip install countdown-cli
 
 
-Usage
------
-
-Please see the `Command-line Reference <Usage_>`_ for details.
-
-
 Contributing
 ------------
 
@@ -145,5 +140,4 @@ This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter
 .. _pip: https://pip.pypa.io/
 .. github-only
 .. _Contributor Guide: CONTRIBUTING.rst
-.. _Usage: https://countdown-cli.readthedocs.io/en/latest/usage.html
 

{countdown-cli-1.0.2 → countdown_cli-1.0.3}/README.rst

@@ -3,7 +3,7 @@ countdown-cli
 
 |PyPI| |Status| |Python Version| |License|
 
-|Read the Docs| |Tests| |Codecov|
+|Tests| |Codecov|
 
 |pre-commit| |Black|
 
@@ -19,9 +19,6 @@ countdown-cli
 .. |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
@@ -40,11 +37,15 @@ If you're working on that exercise right now, please **don't look at the source
 
 |Logo|
 
-.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/python-morsels-logo.png
+.. |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
 --------
@@ -56,11 +57,11 @@ Features
 
 |14:57|
 
-.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/3253.png
+.. |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/docs/images/1457.png
+.. |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)
 
@@ -81,12 +82,6 @@ You can install *countdown-cli* via pip_ from PyPI_:
    $ python3 -m pip install countdown-cli
 
 
-Usage
------
-
-Please see the `Command-line Reference <Usage_>`_ for details.
-
-
 Contributing
 ------------
 
@@ -123,4 +118,3 @@ This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter
 .. _pip: https://pip.pypa.io/
 .. github-only
 .. _Contributor Guide: CONTRIBUTING.rst
-.. _Usage: https://countdown-cli.readthedocs.io/en/latest/usage.html

{countdown-cli-1.0.2 → countdown_cli-1.0.3}/pyproject.toml

@@ -1,55 +1,52 @@
 [tool.poetry]
 name = "countdown-cli"
-version = "1.0.2"
+version = "1.0.3"
 description = "Terminal program to display countdown timer"
 authors = ["Trey Hunner <trey@treyhunner.com>"]
 license = "MIT"
 readme = "README.rst"
 homepage = "https://github.com/treyhunner/countdown-cli"
 repository = "https://github.com/treyhunner/countdown-cli"
-documentation = "https://countdown-cli.readthedocs.io"
 packages = [
     { include = "countdown", from = "src" },
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 
 [tool.poetry.urls]
 Changelog = "https://github.com/treyhunner/countdown-cli/releases"
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.8.1"
 click = "^8.0.1"
 
 [tool.poetry.dev-dependencies]
-pytest = "^7.0.0"
-coverage = {extras = ["toml"], version = "^6.2"}
-safety = "^1.10.3"
-mypy = "^0.931"
-typeguard = "^2.13.3"
-xdoctest = {extras = ["colors"], version = "^0.15.10"}
-sphinx = "^4.3.2"
-sphinx-autobuild = ">=2021.3.14"
+pytest = "^8.2.0"
+coverage = {extras = ["toml"], version = "^7.5.1"}
 pre-commit = "^2.16.0"
-flake8 = "^4.0.1"
-black = ">=21.10b0"
-flake8-bandit = "^2.1.2"
-flake8-bugbear = "^22.1.11"
-flake8-docstrings = "^1.6.0"
-flake8-rst-docstrings = "^0.2.5"
-pep8-naming = "^0.12.1"
-darglint = "^1.8.1"
-reorder-python-imports = "^2.6.0"
-pre-commit-hooks = "^4.1.0"
-sphinx-click = "^3.0.2"
-Pygments = "^2.11.2"
-pyupgrade = "^2.31.0"
-furo = ">=2021.11.12"
+flake8 = "^7.0.0"
+black = "^24.4.2"
+flake8-bandit = "^4.1.1"
+flake8-bugbear = "^24.4.26"
+flake8-docstrings = "^1.7.0"
+flake8-rst-docstrings = "^0.3.0"
+pep8-naming = "^0.13.3"
+reorder-python-imports = "^3.12.0"
+pre-commit-hooks = "^4.6.0"
+docutils = { version = "!=0.21.post1", optional = true }
 
 [tool.poetry.scripts]
 countdown = "countdown.__main__:main"
 
+[tool.poetry.group.dev.dependencies]
+tomli = "^2.0.1"
+
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]
 tests = ["tests", "*/tests"]
@@ -60,7 +57,7 @@ source = ["countdown", "tests"]
 
 [tool.coverage.report]
 show_missing = true
-fail_under = 100
+fail_under = 96
 
 [tool.mypy]
 strict = true

{countdown-cli-1.0.2 → countdown_cli-1.0.3}/src/countdown/__main__.py

@@ -1,5 +1,4 @@
 """Command-line interface."""
-from __future__ import annotations
 
 import re
 import shutil
@@ -46,7 +45,7 @@ CHARS = {
 CLEAR = "\033[H\033[J"
 
 
-def duration(string: str) -> int:
+def duration(string):
     """Convert given XmXs string to seconds (as an integer)."""
     match = DURATION_RE.search(string)
     if not match:
@@ -58,7 +57,7 @@ def duration(string: str) -> int:
 @click.command()
 @click.version_option(package_name="countdown-cli")
 @click.argument("duration", type=duration)
-def main(duration: int) -> None:
+def main(duration):
     """Countdown from the given duration to 0.
 
     DURATION should be a number followed by m or s for minutes or seconds.
@@ -67,7 +66,7 @@ def main(duration: int) -> None:
 
     \b
     - 5m (5 minutes)
-    - 45s (30 seconds)
+    - 45s (45 seconds)
     - 2m30s (2 minutes and 30 seconds)
     """  # noqa: D301
     enable_ansi_escape_codes()
@@ -83,7 +82,7 @@ def main(duration: int) -> None:
         print(SHOW_CURSOR + DISABLE_ALT_BUFFER, end="")
 
 
-def enable_ansi_escape_codes() -> None:
+def enable_ansi_escape_codes():
     """If running on Windows, enable ANSI escape codes."""
     if sys.platform == "win32":  # pragma: no cover
         from ctypes import windll
@@ -101,7 +100,7 @@ def enable_ansi_escape_codes() -> None:
         )
 
 
-def print_full_screen(lines: list[str]) -> None:
+def print_full_screen(lines):
     """Print the given lines centered in the middle of the terminal window."""
     width, height = shutil.get_terminal_size()
     width -= max(len(line) for line in lines)
@@ -111,7 +110,7 @@ def print_full_screen(lines: list[str]) -> None:
     print(CLEAR + vertical_pad + padded_text, flush=True)
 
 
-def get_number_lines(seconds: int) -> list[str]:
+def get_number_lines(seconds):
     """Return list of lines which make large MM:SS glyphs for given seconds."""
     lines = [""] * 5
     minutes, seconds = divmod(seconds, 60)

countdown-cli-1.0.2/setup.py

@@ -1,38 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-package_dir = \
-{'': 'src'}
-
-packages = \
-['countdown']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['click>=8.0.1,<9.0.0']
-
-entry_points = \
-{'console_scripts': ['countdown = countdown.__main__:main']}
-
-setup_kwargs = {
-    'name': 'countdown-cli',
-    'version': '1.0.2',
-    'description': 'Terminal program to display countdown timer',
-    'long_description': "countdown-cli\n=============\n\n|PyPI| |Status| |Python Version| |License|\n\n|Read the Docs| |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.. |Read the Docs| image:: https://img.shields.io/readthedocs/countdown-cli/latest.svg?label=Read%20the%20Docs\n   :target: https://countdown-cli.readthedocs.io/\n   :alt: Read the documentation at https://countdown-cli.readthedocs.io/\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. 😉\n\n|Logo|\n\n.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/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\n\nFeatures\n--------\n\n* Full-screen countdown timer, centered in the terminal window\n* Command-line interface for Linux/Mac/Windows\n\n|32:53|\n\n|14:57|\n\n.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/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/docs/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.7+\n\n\nInstallation\n------------\n\nYou can install *countdown-cli* via pip_ from PyPI_:\n\n.. code:: console\n\n   $ python3 -m pip install countdown-cli\n\n\nUsage\n-----\n\nPlease see the `Command-line Reference <Usage_>`_ for details.\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\nCredits\n-------\n\nThis project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.\n\n.. _Python Morsels: https://www.pythonmorsels.com\n.. _@cjolowicz: https://github.com/cjolowicz\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _MIT license: https://opensource.org/licenses/MIT\n.. _PyPI: https://pypi.org/project/countdown-cli/\n.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n.. _file an issue: https://github.com/treyhunner/countdown-cli/issues\n.. _pip: https://pip.pypa.io/\n.. github-only\n.. _Contributor Guide: CONTRIBUTING.rst\n.. _Usage: https://countdown-cli.readthedocs.io/en/latest/usage.html\n",
-    'author': 'Trey Hunner',
-    'author_email': 'trey@treyhunner.com',
-    'maintainer': None,
-    'maintainer_email': None,
-    'url': 'https://github.com/treyhunner/countdown-cli',
-    'package_dir': package_dir,
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'entry_points': entry_points,
-    'python_requires': '>=3.7,<4.0',
-}
-
-
-setup(**setup_kwargs)