david-haerer / apparition Goto Github PK

Problem

The apparition 0.1.0 package requires at least Python3.10.
This excludes many users who only have an older Python version on their system.

Solution

Use Python3.6 as the minimum Python version.

Problem

• The README.md is a bit overloaded with all --help info.
• It is not entirely clear what the usecase of the tool is.

Solution

• Add a short description to the beginning of the README.md.
• Replace the --help texts with example uses and descriptions.

Tasks

• Setup the pyproject.toml.
• Implement the following commands:
  • apparition install
    • Install the helper shell function in ~/.zshrc.
  • apparition set DESTINATION PATH
    • Save a new destination.
    • This can also be used to update an existing destination.
  • apparition remove DESTINATION
    • Remove a destination.
    • If the destination is unknown the command has no effect.
  • apparition rename OLD_NAME NEW_NAME
    • Rename an existing destination.
  • apparition show
    • Show all destinations in a table.
  • apparition show --list
    • Show all destinations in a list.
  • apparition show DESTINATION
    • Only show the path to the given destination.
  • apparition check
    • Check all destinations if their path is a directory.
  • apparition purge
    • Remove all destinations.
    • The command asks for confirmation before removing all destinations.
  • apparate DESTINATION
    • Change the working directory to the path for DESTINATION via a shell function.
  • apparition apparate --unsafe DESTINATION
    • Change the working directory to the path for DESTINATION in pure Python.
    • See StackOverflow for reference.
• Style with black, isort and pylint.
• Manual testing on Linux / zsh.
• End-to-end test coverage.
• Document the app in the README.md
• Add MIT license.
• Build the package and publish to PyPi.