lightcc / openpegs Goto Github PK

Missing unit/system tests for the final commit or two on the initial release - the PegPyramid class and pegs.py file.

• PegBoard and PegPyramid with 90% coverage
• pegs.py deferred - it's top-level system testing, not unit

Need to figure out how to do coverage analysis and get additional reporting from pytest as well.

• added pytest-cov python package to workspace for coverage, and Coverage Gutters vs code extension.
  • Usage:
    • Run pytest ./texts --cov=src.pegs --cov-report=xml:cov.xml to run coverage with basic settings so the extension will pick it up.
    • Can't get it to use the .coveragerc file, and if I add the command-line options to the pytest settings in vs code, it will not stop on breakpoints for the debugger for tests.

At minimum, provide some kind of guidance on how to use/run the file at the command line (i.e. --help argument) or similar, but maybe also a file or some command to pull up help during the game.

Preferably stored in a common file that is stored in the exe through pyinstaller, or similar. Could be a section of the README.md file for a single source of truth.

Need to add some "Press Enter to close" prompt so user can read the outcome.

Major feature is to provide analyzers that can solve the game.

Need to work out the details. i.e. solve from scratch, for any starting position? Solve the best solutions from the current board? Etc.

Go through the console input/output and tweak it:

• Improve the key feedback so it takes single keypresses rather than requiring enter
• Analyze the full process of printing and entry and optimize
• reevaluate whether to use the node + pegs side-by-side format for showing the game board
• consider adding color and/or other ASCII art/emphasis
• consider clearing/updating the screen rather than just scrolling

Need to create the right command or hook file (and command) to get PyInstaller to include the .egg-info directory and metadata. This is the link to get the released version from Git into the final exe so it can report the version.

Then add sys.argv arguments from the command line and spit out the version when asked for (i.e. something like '--version'.

I'm getting errors trying to update the metadata.

i.e. py setup.py xxx fails out with various errors.

• Fix the setup.py problems, including getting pbr to pull the version from the git tags

• Write a process to release, something like:

  1. push to git on feature branch, review tests and code, etc.
  2. create prerelease exe with version updates
  3. merge to dev/master
  4. create tag on dev/master
  5. update metadata with setup.py
  6. run pyinstaller to create exe with latest metadata
  7. create github release and attach exe