cube-cli 0.4.0__tar.gz → 0.4.2__tar.gz

{cube_cli-0.4.0 → cube_cli-0.4.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: cube-cli
-Version: 0.4.0
-Summary: A CLI application for interacting with cube_model
+Version: 0.4.2
+Summary: A CLI application for the 3x3x3 cube
 Requires-Python: >=3.13,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
@@ -19,43 +19,64 @@ puzzles based on it.
 
     cube [options] [file]
 
-[file] is a saved cube from a previous session. If not specified,
+`[file]` is a saved cube from a previous session. If not specified,
 the cube is initialized to its solved state.
 
 ## Options
 
---help
---version
+`--help`
+
+`--version`
 
 ## Commands
 
 Before you enter a command, the current state of the cube is printed
 in a textual format.
 
-\<moves> A sequence of moves in standard cube move syntax.
+**\<moves>**
+
+A sequence of moves in standard cube move syntax.
 Case-insensitive. To specify a wide move, use a 'w' suffix.
 
-^\<moves> A sequence of moves in standard cube move syntax.
+**^\<moves>**
+
+A sequence of moves in standard cube move syntax.
 Case-sensitive. To specify a wide move, use either a lower-case face
 letter or a 'w' suffix.
 
-solve Return the cube to its initial solved position.
+**solve**
+
+Return the cube to its initial solved position.
+
+**shuffle**
+
+Randomize the position of the cube.
 
-shuffle Randomize the position of the cube.
+**undo**
 
-undo Undo the last previous command.
+Undo the last previous command.
 
-redo If the last previous command was an undo, reverse its effect.
+**redo**
 
-save [file] Save the cube to a file. If [file] is not specified, save
+If the last previous command was an undo, reverse its effect.
+
+**save [file]**
+
+Save the cube to a file. If `[file]` is not specified, save
 to the last file used for a load or save, or to cube.json in the
 current directory.
 
-load [file] Load a saved cube. If [file] is not specified, load from
+**load [file]**
+
+Load a saved cube. If `[file]` is not specified, load from
 the last file used for a load or save, or to cube.json in the
 current directory.
 
-help, ? Print this command reference.
+**help, ?**
+
+Print this command reference.
+
+**quit, q**
 
-quit, q Exit cube.
+Exit cube.
 

cube_cli-0.4.2/README.md

@@ -0,0 +1,69 @@
+# cube-cli
+
+A textual cli environment for manipulating a 3x3x3 cube and solving
+puzzles based on it.
+
+## Usage
+
+    cube [options] [file]
+
+`[file]` is a saved cube from a previous session. If not specified,
+the cube is initialized to its solved state.
+
+## Options
+
+`--help`
+
+`--version`
+
+## Commands
+
+Before you enter a command, the current state of the cube is printed
+in a textual format.
+
+**\<moves>**
+
+A sequence of moves in standard cube move syntax.
+Case-insensitive. To specify a wide move, use a 'w' suffix.
+
+**^\<moves>**
+
+A sequence of moves in standard cube move syntax.
+Case-sensitive. To specify a wide move, use either a lower-case face
+letter or a 'w' suffix.
+
+**solve**
+
+Return the cube to its initial solved position.
+
+**shuffle**
+
+Randomize the position of the cube.
+
+**undo**
+
+Undo the last previous command.
+
+**redo**
+
+If the last previous command was an undo, reverse its effect.
+
+**save [file]**
+
+Save the cube to a file. If `[file]` is not specified, save
+to the last file used for a load or save, or to cube.json in the
+current directory.
+
+**load [file]**
+
+Load a saved cube. If `[file]` is not specified, load from
+the last file used for a load or save, or to cube.json in the
+current directory.
+
+**help, ?**
+
+Print this command reference.
+
+**quit, q**
+
+Exit cube.

{cube_cli-0.4.0 → cube_cli-0.4.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cube-cli"
-version = "0.4.0"
-description = "A CLI application for interacting with cube_model"
+version = "0.4.2"
+description = "A CLI application for the 3x3x3 cube"
 authors = []
 readme = "README.md"
 repository = "https://github.com/ygale/cube-cli"

{cube_cli-0.4.0 → cube_cli-0.4.2}/src/cube_cli/repl.py

@@ -2,27 +2,24 @@
 import readline
 
 from cube_model import Cube, solved
+from typing import cast
 
 from .command import Command, Quit, Tabbable, all_commands
 from .print import print_cube
 from .repl_state import Alias, Exit, LoadError, ReplState
 from .save_load import SaveError, load
 
-# All tab completion candidates
+# All tab completion candidates.
+# Use cast to work around mypy bug.
 _COMPLETIONS: list[str] = sorted(a.name
   for c in all_commands if issubclass(c, Tabbable)
-  for a in c.aliases)
+  for a in cast(Tabbable, c).aliases)
 
 # Do not tab complete if it might be a Move.
-# Avoid comprehension due to mypy bug.
-_NON_COMPLETIONS: set[str] = set()
-cmd: type[Command]
-alias: Alias
-for cmd in all_commands:
-  if issubclass(cmd, Tabbable):
-    for alias in cmd.aliases:
-      if alias.min_chars > 1:
-        _NON_COMPLETIONS.add(alias.name[:alias.min_chars - 1])
+# Use cast to work around mypy bug.
+_NON_COMPLETIONS: set[str] = {a.name[:a.min_chars - 1]
+  for c in all_commands if issubclass(c, Tabbable)
+  for a in cast(Tabbable, c).aliases if a.min_chars > 1}
 
 # Cached tab completion candidates for a specific input text
 _matches: list[str] = []

{cube_cli-0.4.0 → cube_cli-0.4.2}/src/cube_cli/save_load.py

@@ -22,7 +22,7 @@ def save(cube: Cube, filename: str) -> SaveError | None:
   cj['version'] = get_version()
   try:
     with open(filename, 'w') as f:
-      json.dump(cj, f)
+      json.dump(cj, f, separators=(',',':'))
   except PermissionError:
     return SaveError('permission denied')
   except OSError:

cube_cli-0.4.0/README.md

@@ -1,48 +0,0 @@
-# cube-cli
-
-A textual cli environment for manipulating a 3x3x3 cube and solving
-puzzles based on it.
-
-## Usage
-
-    cube [options] [file]
-
-[file] is a saved cube from a previous session. If not specified,
-the cube is initialized to its solved state.
-
-## Options
-
---help
---version
-
-## Commands
-
-Before you enter a command, the current state of the cube is printed
-in a textual format.
-
-\<moves> A sequence of moves in standard cube move syntax.
-Case-insensitive. To specify a wide move, use a 'w' suffix.
-
-^\<moves> A sequence of moves in standard cube move syntax.
-Case-sensitive. To specify a wide move, use either a lower-case face
-letter or a 'w' suffix.
-
-solve Return the cube to its initial solved position.
-
-shuffle Randomize the position of the cube.
-
-undo Undo the last previous command.
-
-redo If the last previous command was an undo, reverse its effect.
-
-save [file] Save the cube to a file. If [file] is not specified, save
-to the last file used for a load or save, or to cube.json in the
-current directory.
-
-load [file] Load a saved cube. If [file] is not specified, load from
-the last file used for a load or save, or to cube.json in the
-current directory.
-
-help, ? Print this command reference.
-
-quit, q Exit cube.