countdown-cli 2.0.0__tar.gz → 2.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.claude/settings.local.json +2 -1
- countdown_cli-2.2.0/.envrc +1 -0
- countdown_cli-2.2.0/.serena/.gitignore +2 -0
- countdown_cli-2.2.0/.serena/project.local.yml +5 -0
- countdown_cli-2.2.0/.serena/project.yml +152 -0
- countdown_cli-2.2.0/.uv-cache/.gitignore +1 -0
- countdown_cli-2.2.0/.uv-cache/.lock +0 -0
- countdown_cli-2.2.0/.uv-cache/CACHEDIR.TAG +1 -0
- countdown_cli-2.2.0/.uv-cache/interpreter-v4/3ae53c40791d22fd/16472b94e5618f48.msgpack +0 -0
- countdown_cli-2.2.0/.uv-cache/sdists-v9/.git +0 -0
- countdown_cli-2.2.0/.uv-cache/sdists-v9/.gitignore +0 -0
- countdown_cli-2.2.0/AGENTS.md +12 -0
- countdown_cli-2.2.0/CLAUDE.md +1 -0
- countdown_cli-2.2.0/CONTRIBUTING.rst +75 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/PKG-INFO +9 -11
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/README.rst +7 -9
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/class_index.html +22 -22
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/function_index.html +475 -195
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/index.html +19 -19
- countdown_cli-2.2.0/htmlcov/status.json +1 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da___init___py.html +4 -4
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da___main___py.html +82 -73
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da_digits_py.html +37 -32
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da_display_py.html +80 -67
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da_keys_py.html +4 -4
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da_terminal_py.html +8 -8
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_55719c21e2af63da_timer_py.html +6 -6
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_a44f0ac069e85531___init___py.html +6 -6
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_a44f0ac069e85531_conftest_py.html +6 -6
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_a44f0ac069e85531_test_display_py.html +258 -195
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_a44f0ac069e85531_test_keys_py.html +32 -28
- countdown_cli-2.2.0/htmlcov/z_a44f0ac069e85531_test_main_py.html +948 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_a44f0ac069e85531_test_terminal_py.html +4 -4
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/z_a44f0ac069e85531_test_timer_py.html +120 -104
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/pyproject.toml +2 -10
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/__main__.py +20 -9
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/digits.py +7 -2
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/display.py +26 -13
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/terminal.py +2 -2
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/timer.py +2 -2
- countdown_cli-2.2.0/tests/conftest.py +98 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/tests/test_display.py +92 -29
- countdown_cli-2.2.0/tests/test_drift.py +222 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/tests/test_keys.py +9 -5
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/tests/test_main.py +127 -126
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/tests/test_timer.py +16 -0
- countdown_cli-2.2.0/uv.lock +319 -0
- countdown_cli-2.0.0/.envrc +0 -1
- countdown_cli-2.0.0/CONTRIBUTING.rst +0 -121
- countdown_cli-2.0.0/htmlcov/status.json +0 -1
- countdown_cli-2.0.0/htmlcov/z_a44f0ac069e85531_test_main_py.html +0 -650
- countdown_cli-2.0.0/tests/conftest.py +0 -29
- countdown_cli-2.0.0/uv.lock +0 -319
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.gitattributes +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.github/labels.yml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.github/release-drafter.yml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.github/workflows/labeler.yml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.github/workflows/release.yml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.github/workflows/tests.yml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.gitignore +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.pre-commit-config.yaml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/.python-version-default +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/CODE_OF_CONDUCT.rst +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/LICENSE.rst +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/codecov.yml +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/.gitignore +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/coverage_html_cb_6fb7b396.js +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/coverage_html_cb_da166b87.js +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/favicon_32_cb_58284776.png +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/keybd_closed_cb_ce680311.png +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/style_cb_6b508a39.css +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/htmlcov/style_cb_8e611ae1.css +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/images/1457.png +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/images/3253.png +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/images/python-morsels-logo.png +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/justfile +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/noxfile.py +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/__init__.py +0 -0
- /countdown_cli-2.0.0/src/countdown/numbers.txt → /countdown_cli-2.2.0/src/countdown/glyphs.txt +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/src/countdown/keys.py +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/tests/__init__.py +0 -0
- {countdown_cli-2.0.0 → countdown_cli-2.2.0}/tests/test_terminal.py +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export UV_PUBLISH_TOKEN=pypi-AgEIcHlwaS5vcmcCJDhmNDdkMDM1LWM4YjgtNDlmNS1hMzEyLTM2YWM2YzZjYWRmZAACFVsxLFsiY291bnRkb3duLWNsaSJdXQACLFsyLFsiZDMzNmM3YzgtZWM1Yy00MTY1LWJlZjUtZjY4YjJiYzE2M2NiIl1dAAAGIL6CAdUYjyGIP7v1Dl9nX3nhlZPtBWLxiKjLfHcMnu0Y
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# This file allows you to locally override settings in project.yml for development purposes.
|
|
2
|
+
#
|
|
3
|
+
# Use the same keys as in project.yml here. Any setting you specify will override the corresponding
|
|
4
|
+
# setting in project.yml, allowing you to customise the configuration for your local development environment
|
|
5
|
+
# without affecting the project configuration in project.yml (which is intended to be versioned).
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# the name by which the project can be referenced within Serena
|
|
2
|
+
project_name: "countdown-cli"
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
# list of languages for which language servers are started; choose from:
|
|
6
|
+
# al bash clojure cpp csharp
|
|
7
|
+
# csharp_omnisharp dart elixir elm erlang
|
|
8
|
+
# fortran fsharp go groovy haskell
|
|
9
|
+
# java julia kotlin lua markdown
|
|
10
|
+
# matlab nix pascal perl php
|
|
11
|
+
# php_phpactor powershell python python_jedi r
|
|
12
|
+
# rego ruby ruby_solargraph rust scala
|
|
13
|
+
# swift terraform toml typescript typescript_vts
|
|
14
|
+
# vue yaml zig
|
|
15
|
+
# (This list may be outdated. For the current list, see values of Language enum here:
|
|
16
|
+
# https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
|
|
17
|
+
# For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
|
|
18
|
+
# Note:
|
|
19
|
+
# - For C, use cpp
|
|
20
|
+
# - For JavaScript, use typescript
|
|
21
|
+
# - For Free Pascal/Lazarus, use pascal
|
|
22
|
+
# Special requirements:
|
|
23
|
+
# Some languages require additional setup/installations.
|
|
24
|
+
# See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
|
|
25
|
+
# When using multiple languages, the first language server that supports a given file will be used for that file.
|
|
26
|
+
# The first language is the default language and the respective language server will be used as a fallback.
|
|
27
|
+
# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
|
|
28
|
+
languages:
|
|
29
|
+
- python
|
|
30
|
+
|
|
31
|
+
# the encoding used by text files in the project
|
|
32
|
+
# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
|
|
33
|
+
encoding: "utf-8"
|
|
34
|
+
|
|
35
|
+
# line ending convention to use when writing source files.
|
|
36
|
+
# Possible values: unset (use global setting), "lf", "crlf", or "native" (platform default)
|
|
37
|
+
# This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
|
|
38
|
+
line_ending:
|
|
39
|
+
|
|
40
|
+
# The language backend to use for this project.
|
|
41
|
+
# If not set, the global setting from serena_config.yml is used.
|
|
42
|
+
# Valid values: LSP, JetBrains
|
|
43
|
+
# Note: the backend is fixed at startup. If a project with a different backend
|
|
44
|
+
# is activated post-init, an error will be returned.
|
|
45
|
+
language_backend:
|
|
46
|
+
|
|
47
|
+
# whether to use project's .gitignore files to ignore files
|
|
48
|
+
ignore_all_files_in_gitignore: true
|
|
49
|
+
|
|
50
|
+
# advanced configuration option allowing to configure language server-specific options.
|
|
51
|
+
# Maps the language key to the options.
|
|
52
|
+
# Have a look at the docstring of the constructors of the LS implementations within solidlsp (e.g., for C# or PHP) to see which options are available.
|
|
53
|
+
# No documentation on options means no options are available.
|
|
54
|
+
ls_specific_settings: {}
|
|
55
|
+
|
|
56
|
+
# list of additional paths to ignore in this project.
|
|
57
|
+
# Same syntax as gitignore, so you can use * and **.
|
|
58
|
+
# Note: global ignored_paths from serena_config.yml are also applied additively.
|
|
59
|
+
ignored_paths: []
|
|
60
|
+
|
|
61
|
+
# whether the project is in read-only mode
|
|
62
|
+
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
|
63
|
+
# Added on 2025-04-18
|
|
64
|
+
read_only: false
|
|
65
|
+
|
|
66
|
+
# list of tool names to exclude.
|
|
67
|
+
# This extends the existing exclusions (e.g. from the global configuration)
|
|
68
|
+
#
|
|
69
|
+
# Below is the complete list of tools for convenience.
|
|
70
|
+
# To make sure you have the latest list of tools, and to view their descriptions,
|
|
71
|
+
# execute `uv run scripts/print_tool_overview.py`.
|
|
72
|
+
#
|
|
73
|
+
# * `activate_project`: Activates a project by name.
|
|
74
|
+
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
|
75
|
+
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
|
76
|
+
# * `delete_lines`: Deletes a range of lines within a file.
|
|
77
|
+
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
|
|
78
|
+
# * `execute_shell_command`: Executes a shell command.
|
|
79
|
+
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
|
|
80
|
+
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
|
81
|
+
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
|
82
|
+
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
|
83
|
+
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
|
84
|
+
# * `initial_instructions`: Gets the initial instructions for the current project.
|
|
85
|
+
# Should only be used in settings where the system prompt cannot be set,
|
|
86
|
+
# e.g. in clients you have no control over, like Claude Desktop.
|
|
87
|
+
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
|
88
|
+
# * `insert_at_line`: Inserts content at a given line in a file.
|
|
89
|
+
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
|
90
|
+
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
|
91
|
+
# * `list_memories`: Lists memories in Serena's project-specific memory store.
|
|
92
|
+
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
|
93
|
+
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
|
|
94
|
+
# * `read_file`: Reads a file within the project directory.
|
|
95
|
+
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
|
|
96
|
+
# * `remove_project`: Removes a project from the Serena configuration.
|
|
97
|
+
# * `replace_lines`: Replaces a range of lines within a file with new content.
|
|
98
|
+
# * `replace_symbol_body`: Replaces the full definition of a symbol.
|
|
99
|
+
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
|
|
100
|
+
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
|
101
|
+
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
|
|
102
|
+
# * `switch_modes`: Activates modes by providing a list of their names
|
|
103
|
+
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
|
|
104
|
+
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
|
|
105
|
+
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
|
|
106
|
+
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
|
|
107
|
+
excluded_tools: []
|
|
108
|
+
|
|
109
|
+
# list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
|
|
110
|
+
# This extends the existing inclusions (e.g. from the global configuration).
|
|
111
|
+
included_optional_tools: []
|
|
112
|
+
|
|
113
|
+
# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
|
|
114
|
+
# This cannot be combined with non-empty excluded_tools or included_optional_tools.
|
|
115
|
+
fixed_tools: []
|
|
116
|
+
|
|
117
|
+
# list of mode names to that are always to be included in the set of active modes
|
|
118
|
+
# The full set of modes to be activated is base_modes + default_modes.
|
|
119
|
+
# If the setting is undefined, the base_modes from the global configuration (serena_config.yml) apply.
|
|
120
|
+
# Otherwise, this setting overrides the global configuration.
|
|
121
|
+
# Set this to [] to disable base modes for this project.
|
|
122
|
+
# Set this to a list of mode names to always include the respective modes for this project.
|
|
123
|
+
base_modes:
|
|
124
|
+
|
|
125
|
+
# list of mode names that are to be activated by default.
|
|
126
|
+
# The full set of modes to be activated is base_modes + default_modes.
|
|
127
|
+
# If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
|
|
128
|
+
# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
|
|
129
|
+
# This setting can, in turn, be overridden by CLI parameters (--mode).
|
|
130
|
+
default_modes:
|
|
131
|
+
|
|
132
|
+
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
|
133
|
+
# (contrary to the memories, which are loaded on demand).
|
|
134
|
+
initial_prompt: ""
|
|
135
|
+
|
|
136
|
+
# time budget (seconds) per tool call for the retrieval of additional symbol information
|
|
137
|
+
# such as docstrings or parameter information.
|
|
138
|
+
# This overrides the corresponding setting in the global configuration; see the documentation there.
|
|
139
|
+
# If null or missing, use the setting from the global configuration.
|
|
140
|
+
symbol_info_budget:
|
|
141
|
+
|
|
142
|
+
# list of regex patterns which, when matched, mark a memory entry as read‑only.
|
|
143
|
+
# Extends the list from the global configuration, merging the two lists.
|
|
144
|
+
read_only_memory_patterns: []
|
|
145
|
+
|
|
146
|
+
# list of regex patterns for memories to completely ignore.
|
|
147
|
+
# Matching memories will not appear in list_memories or activate_project output
|
|
148
|
+
# and cannot be accessed via read_memory or write_memory.
|
|
149
|
+
# To access ignored memory files, use the read_file tool on the raw file path.
|
|
150
|
+
# Extends the list from the global configuration, merging the two lists.
|
|
151
|
+
# Example: ["_archive/.*", "_episodes/.*"]
|
|
152
|
+
ignored_memory_patterns: []
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
*
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Signature: 8a477f597d28d172789f06886806bc55
|
|
Binary file
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Repository Guidelines
|
|
2
|
+
|
|
3
|
+
## Structure
|
|
4
|
+
- `src/countdown/` hosts the CLI (`__main__.py`, `timer.py`, `display.py`, `terminal.py`, `keys.py`, `glyphs.txt`); `tests/` mirrors each module.
|
|
5
|
+
- Tooling lives in `justfile`, `pyproject.toml`, and `noxfile.py`; see `CONTRIBUTING.rst` if you need the long-form tour.
|
|
6
|
+
|
|
7
|
+
## Workflow
|
|
8
|
+
- `just check` runs format + lint + pytest; treat it as the pre-push gate.
|
|
9
|
+
- `just test [-- -k expr]`, `just test-cov`, and `just test-all` cover targeted, coverage, and multi-Python runs.
|
|
10
|
+
|
|
11
|
+
## Style
|
|
12
|
+
- Use `just format` instead of manual tweaks; keep docstrings concise and only add type hints when they clarify intent.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
See @AGENTS.md
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
Contributor Guide
|
|
2
|
+
=================
|
|
3
|
+
|
|
4
|
+
How to report a bug
|
|
5
|
+
-------------------
|
|
6
|
+
|
|
7
|
+
Report bugs on the `Issue Tracker`_.
|
|
8
|
+
|
|
9
|
+
When filing an issue, make sure to answer these questions:
|
|
10
|
+
|
|
11
|
+
- Which operating system and Python version are you using?
|
|
12
|
+
- Which version of this project are you using?
|
|
13
|
+
- What did you do?
|
|
14
|
+
- What did you expect to see?
|
|
15
|
+
- What did you see instead?
|
|
16
|
+
|
|
17
|
+
The best way to get your bug fixed is to provide a test case,
|
|
18
|
+
and/or steps to reproduce the issue.
|
|
19
|
+
|
|
20
|
+
.. _Issue Tracker: https://github.com/treyhunner/countdown-cli/issues
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
How to request a feature
|
|
24
|
+
------------------------
|
|
25
|
+
|
|
26
|
+
Request features on the `Issue Tracker`_.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
How to set up your development environment
|
|
30
|
+
------------------------------------------
|
|
31
|
+
|
|
32
|
+
You need Python, uv_, and just_ installed locally.
|
|
33
|
+
Nox_ is optional but required for the multi-version test matrix.
|
|
34
|
+
|
|
35
|
+
The CLI is exposed through the ``countdown`` script.
|
|
36
|
+
Run it directly from the synced environment:
|
|
37
|
+
|
|
38
|
+
.. code:: console
|
|
39
|
+
|
|
40
|
+
uv run countdown 6m30s
|
|
41
|
+
|
|
42
|
+
.. _uv: https://docs.astral.sh/uv/
|
|
43
|
+
.. _just: https://github.com/casey/just
|
|
44
|
+
.. _Nox: https://nox.thea.codes/
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
How to test the project
|
|
48
|
+
-----------------------
|
|
49
|
+
|
|
50
|
+
This project uses pytest_ and Ruff_ orchestrated through ``just`` tasks.
|
|
51
|
+
Before opening a pull request, run the aggregated check:
|
|
52
|
+
|
|
53
|
+
.. code:: console
|
|
54
|
+
|
|
55
|
+
just check
|
|
56
|
+
|
|
57
|
+
Useful individual commands:
|
|
58
|
+
|
|
59
|
+
.. code:: console
|
|
60
|
+
|
|
61
|
+
just test -- -k timer
|
|
62
|
+
just test-cov # pytest with coverage (fail_under=100)
|
|
63
|
+
|
|
64
|
+
Unit tests are located in the ``tests`` directory,
|
|
65
|
+
and are written using the pytest_ testing framework.
|
|
66
|
+
Open ``htmlcov/index.html`` after ``just test-cov`` to debug coverage issues.
|
|
67
|
+
|
|
68
|
+
If you need to validate across every supported Python version, run:
|
|
69
|
+
|
|
70
|
+
.. code:: console
|
|
71
|
+
|
|
72
|
+
just test-all
|
|
73
|
+
|
|
74
|
+
.. _pytest: https://pytest.readthedocs.io/
|
|
75
|
+
.. _Ruff: https://docs.astral.sh/ruff/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: countdown-cli
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.2.0
|
|
4
4
|
Summary: Terminal program to display countdown timer
|
|
5
5
|
Project-URL: homepage, https://github.com/treyhunner/countdown-cli
|
|
6
6
|
Project-URL: repository, https://github.com/treyhunner/countdown-cli
|
|
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.13
|
|
|
16
16
|
Classifier: Programming Language :: Python :: 3.14
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.15
|
|
18
18
|
Requires-Python: >=3.10
|
|
19
|
-
Requires-Dist: click>=8.0
|
|
19
|
+
Requires-Dist: click>=8.3.0
|
|
20
20
|
Description-Content-Type: text/x-rst
|
|
21
21
|
|
|
22
22
|
countdown-cli
|
|
@@ -26,8 +26,6 @@ countdown-cli
|
|
|
26
26
|
|
|
27
27
|
|Tests| |Codecov|
|
|
28
28
|
|
|
29
|
-
|pre-commit| |Black|
|
|
30
|
-
|
|
31
29
|
.. |PyPI| image:: https://img.shields.io/pypi/v/countdown-cli.svg
|
|
32
30
|
:target: https://pypi.org/project/countdown-cli/
|
|
33
31
|
:alt: PyPI
|
|
@@ -46,12 +44,6 @@ countdown-cli
|
|
|
46
44
|
.. |Codecov| image:: https://codecov.io/gh/treyhunner/countdown-cli/branch/main/graph/badge.svg
|
|
47
45
|
:target: https://codecov.io/gh/treyhunner/countdown-cli
|
|
48
46
|
:alt: Codecov
|
|
49
|
-
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
|
|
50
|
-
:target: https://github.com/pre-commit/pre-commit
|
|
51
|
-
:alt: pre-commit
|
|
52
|
-
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
53
|
-
:target: https://github.com/psf/black
|
|
54
|
-
:alt: Black
|
|
55
47
|
|
|
56
48
|
This project is based on a `Python Morsels`_ exercise for a command-line countdown timer.
|
|
57
49
|
If you're working on that exercise right now, please **don't look at the source code** for this. 😉
|
|
@@ -77,6 +69,12 @@ Features
|
|
|
77
69
|
- Pause/resume with ``p``, ``k``, ``Space``, or ``Enter``
|
|
78
70
|
- Add / remove time with ``+`` or ``-``
|
|
79
71
|
|
|
72
|
+
To start a timer:
|
|
73
|
+
|
|
74
|
+
.. code:: console
|
|
75
|
+
|
|
76
|
+
countdown 6m30s
|
|
77
|
+
|
|
80
78
|
|32:53|
|
|
81
79
|
|
|
82
80
|
|14:57|
|
|
@@ -103,7 +101,7 @@ You can install **countdown-cli** via uv_ from PyPI_:
|
|
|
103
101
|
|
|
104
102
|
.. code:: console
|
|
105
103
|
|
|
106
|
-
|
|
104
|
+
uv tool install countdown-cli
|
|
107
105
|
|
|
108
106
|
|
|
109
107
|
Contributing
|
|
@@ -5,8 +5,6 @@ countdown-cli
|
|
|
5
5
|
|
|
6
6
|
|Tests| |Codecov|
|
|
7
7
|
|
|
8
|
-
|pre-commit| |Black|
|
|
9
|
-
|
|
10
8
|
.. |PyPI| image:: https://img.shields.io/pypi/v/countdown-cli.svg
|
|
11
9
|
:target: https://pypi.org/project/countdown-cli/
|
|
12
10
|
:alt: PyPI
|
|
@@ -25,12 +23,6 @@ countdown-cli
|
|
|
25
23
|
.. |Codecov| image:: https://codecov.io/gh/treyhunner/countdown-cli/branch/main/graph/badge.svg
|
|
26
24
|
:target: https://codecov.io/gh/treyhunner/countdown-cli
|
|
27
25
|
:alt: Codecov
|
|
28
|
-
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
|
|
29
|
-
:target: https://github.com/pre-commit/pre-commit
|
|
30
|
-
:alt: pre-commit
|
|
31
|
-
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
32
|
-
:target: https://github.com/psf/black
|
|
33
|
-
:alt: Black
|
|
34
26
|
|
|
35
27
|
This project is based on a `Python Morsels`_ exercise for a command-line countdown timer.
|
|
36
28
|
If you're working on that exercise right now, please **don't look at the source code** for this. 😉
|
|
@@ -56,6 +48,12 @@ Features
|
|
|
56
48
|
- Pause/resume with ``p``, ``k``, ``Space``, or ``Enter``
|
|
57
49
|
- Add / remove time with ``+`` or ``-``
|
|
58
50
|
|
|
51
|
+
To start a timer:
|
|
52
|
+
|
|
53
|
+
.. code:: console
|
|
54
|
+
|
|
55
|
+
countdown 6m30s
|
|
56
|
+
|
|
59
57
|
|32:53|
|
|
60
58
|
|
|
61
59
|
|14:57|
|
|
@@ -82,7 +80,7 @@ You can install **countdown-cli** via uv_ from PyPI_:
|
|
|
82
80
|
|
|
83
81
|
.. code:: console
|
|
84
82
|
|
|
85
|
-
|
|
83
|
+
uv tool install countdown-cli
|
|
86
84
|
|
|
87
85
|
|
|
88
86
|
Contributing
|
|
@@ -56,8 +56,8 @@
|
|
|
56
56
|
<a class="button current">Classes</a>
|
|
57
57
|
</h2>
|
|
58
58
|
<p class="text">
|
|
59
|
-
<a class="nav" href="https://coverage.readthedocs.io/en/7.11.
|
|
60
|
-
created at
|
|
59
|
+
<a class="nav" href="https://coverage.readthedocs.io/en/7.11.1">coverage.py v7.11.1</a>,
|
|
60
|
+
created at 2026-03-27 20:23 -0700
|
|
61
61
|
</p>
|
|
62
62
|
</div>
|
|
63
63
|
</header>
|
|
@@ -89,12 +89,12 @@
|
|
|
89
89
|
<tr class="region">
|
|
90
90
|
<td class="name left"><a href="z_55719c21e2af63da___main___py.html">src/countdown/__main__.py</a></td>
|
|
91
91
|
<td class="name left"><a href="z_55719c21e2af63da___main___py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
|
|
92
|
-
<td>
|
|
92
|
+
<td>62</td>
|
|
93
93
|
<td>0</td>
|
|
94
94
|
<td>1</td>
|
|
95
|
-
<td>
|
|
95
|
+
<td>20</td>
|
|
96
96
|
<td>0</td>
|
|
97
|
-
<td class="right" data-ratio="
|
|
97
|
+
<td class="right" data-ratio="82 82">100%</td>
|
|
98
98
|
</tr>
|
|
99
99
|
<tr class="region">
|
|
100
100
|
<td class="name left"><a href="z_55719c21e2af63da_digits_py.html">src/countdown/digits.py</a></td>
|
|
@@ -109,12 +109,12 @@
|
|
|
109
109
|
<tr class="region">
|
|
110
110
|
<td class="name left"><a href="z_55719c21e2af63da_display_py.html">src/countdown/display.py</a></td>
|
|
111
111
|
<td class="name left"><a href="z_55719c21e2af63da_display_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
|
|
112
|
-
<td>
|
|
112
|
+
<td>47</td>
|
|
113
113
|
<td>0</td>
|
|
114
114
|
<td>16</td>
|
|
115
115
|
<td>10</td>
|
|
116
116
|
<td>0</td>
|
|
117
|
-
<td class="right" data-ratio="
|
|
117
|
+
<td class="right" data-ratio="57 57">100%</td>
|
|
118
118
|
</tr>
|
|
119
119
|
<tr class="region">
|
|
120
120
|
<td class="name left"><a href="z_55719c21e2af63da_keys_py.html">src/countdown/keys.py</a></td>
|
|
@@ -169,12 +169,12 @@
|
|
|
169
169
|
<tr class="region">
|
|
170
170
|
<td class="name left"><a href="z_a44f0ac069e85531_test_display_py.html">tests/test_display.py</a></td>
|
|
171
171
|
<td class="name left"><a href="z_a44f0ac069e85531_test_display_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
|
|
172
|
-
<td>
|
|
172
|
+
<td>124</td>
|
|
173
173
|
<td>0</td>
|
|
174
174
|
<td>0</td>
|
|
175
175
|
<td>6</td>
|
|
176
176
|
<td>0</td>
|
|
177
|
-
<td class="right" data-ratio="
|
|
177
|
+
<td class="right" data-ratio="130 130">100%</td>
|
|
178
178
|
</tr>
|
|
179
179
|
<tr class="region">
|
|
180
180
|
<td class="name left"><a href="z_a44f0ac069e85531_test_keys_py.html">tests/test_keys.py</a></td>
|
|
@@ -188,23 +188,23 @@
|
|
|
188
188
|
</tr>
|
|
189
189
|
<tr class="region">
|
|
190
190
|
<td class="name left"><a href="z_a44f0ac069e85531_test_main_py.html#t12">tests/test_main.py</a></td>
|
|
191
|
-
<td class="name left"><a href="z_a44f0ac069e85531_test_main_py.html#t12"><data value='
|
|
192
|
-
<td>
|
|
191
|
+
<td class="name left"><a href="z_a44f0ac069e85531_test_main_py.html#t12"><data value='FakeClock'>FakeClock</data></a></td>
|
|
192
|
+
<td>12</td>
|
|
193
193
|
<td>0</td>
|
|
194
194
|
<td>0</td>
|
|
195
195
|
<td>4</td>
|
|
196
196
|
<td>0</td>
|
|
197
|
-
<td class="right" data-ratio="
|
|
197
|
+
<td class="right" data-ratio="16 16">100%</td>
|
|
198
198
|
</tr>
|
|
199
199
|
<tr class="region">
|
|
200
200
|
<td class="name left"><a href="z_a44f0ac069e85531_test_main_py.html">tests/test_main.py</a></td>
|
|
201
201
|
<td class="name left"><a href="z_a44f0ac069e85531_test_main_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
|
|
202
|
-
<td>
|
|
202
|
+
<td>394</td>
|
|
203
203
|
<td>0</td>
|
|
204
204
|
<td>0</td>
|
|
205
|
-
<td>
|
|
205
|
+
<td>10</td>
|
|
206
206
|
<td>0</td>
|
|
207
|
-
<td class="right" data-ratio="
|
|
207
|
+
<td class="right" data-ratio="404 404">100%</td>
|
|
208
208
|
</tr>
|
|
209
209
|
<tr class="region">
|
|
210
210
|
<td class="name left"><a href="z_a44f0ac069e85531_test_terminal_py.html">tests/test_terminal.py</a></td>
|
|
@@ -219,24 +219,24 @@
|
|
|
219
219
|
<tr class="region">
|
|
220
220
|
<td class="name left"><a href="z_a44f0ac069e85531_test_timer_py.html">tests/test_timer.py</a></td>
|
|
221
221
|
<td class="name left"><a href="z_a44f0ac069e85531_test_timer_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
|
|
222
|
-
<td>
|
|
222
|
+
<td>49</td>
|
|
223
223
|
<td>0</td>
|
|
224
224
|
<td>0</td>
|
|
225
225
|
<td>0</td>
|
|
226
226
|
<td>0</td>
|
|
227
|
-
<td class="right" data-ratio="
|
|
227
|
+
<td class="right" data-ratio="49 49">100%</td>
|
|
228
228
|
</tr>
|
|
229
229
|
</tbody>
|
|
230
230
|
<tfoot>
|
|
231
231
|
<tr class="total">
|
|
232
232
|
<td class="name left">Total</td>
|
|
233
233
|
<td class="name left"> </td>
|
|
234
|
-
<td>
|
|
234
|
+
<td>786</td>
|
|
235
235
|
<td>0</td>
|
|
236
236
|
<td>84</td>
|
|
237
|
-
<td>
|
|
237
|
+
<td>72</td>
|
|
238
238
|
<td>0</td>
|
|
239
|
-
<td class="right" data-ratio="
|
|
239
|
+
<td class="right" data-ratio="858 858">100%</td>
|
|
240
240
|
</tr>
|
|
241
241
|
</tfoot>
|
|
242
242
|
</table>
|
|
@@ -247,8 +247,8 @@
|
|
|
247
247
|
<footer>
|
|
248
248
|
<div class="content">
|
|
249
249
|
<p>
|
|
250
|
-
<a class="nav" href="https://coverage.readthedocs.io/en/7.11.
|
|
251
|
-
created at
|
|
250
|
+
<a class="nav" href="https://coverage.readthedocs.io/en/7.11.1">coverage.py v7.11.1</a>,
|
|
251
|
+
created at 2026-03-27 20:23 -0700
|
|
252
252
|
</p>
|
|
253
253
|
</div>
|
|
254
254
|
<aside class="hidden">
|