Acceptance Criteria

This is an experiment. I want to note down all important parts of the project. We can then give it to AI tools and see how well they generate the code.

General project setup:

  1. Add a .pre-commit-config.yaml

  2. Package it using pyproject.toml and flit. Do not use setup.py. The name of the package is “flitz”.

  3. Test the application using pytest. Avoid using TestCase. Use a pytest fixture instead.

  4. Add sphinx documentation and ensure it’s build on readthedocs

  5. Prefer pathlib over os.

Features:

  1. Create a file explorer application using Python.

  2. Make a list-view: Name, size, Type, Date Modified.

  3. When double-clicking on a folder, the view should descend.

  4. There should be an URL bar showing the current path. An “up” button should be on the left of it. It should only have an image, no text.

  5. Allow changing the font size with Ctrl +/- in the whole application.

  6. Allow sorting by clicking on the Column headers (name, size, type, date modified)

  7. If a parameter is given like flitz /home/foo/bar, then /home/foo/bar should be the path being set when starting flitz.

  8. Create a Config class using Pydantic as well as a static method “load” that returns a Config object. Load the configuration from “~/.flitz.yml”, if it exists. The class should have a single value “font_size: int” with a default of 14.

  9. Pressing F2 when a file/folder is selected lets the user rename that object.

  10. Allow opening a file (double click or Enter) or descend if it’s a folder

  11. Open a search when pressing Ctrl+F

  12. Pressing Esc should: (1) If the context menu is open, close it (2) If not, and if the search is active, deactivate the search

  13. When pressing “DEL”, delete the selected file / folder. Ask for confirmation first.

  14. When making a right-click, open a context menu:

  15. Create Folder

  16. Create Empty file

  17. Rename…

  18. Properties

  19. Ctrl+C should copy the selection, Ctrl+v should paste the selection, Ctrl+x should cut the selection

  20. Allow referencing external_config in the Config file. Those get loaded just like any other configuration. They can (partially) override the existing config.

  21. Ctrl+h toggles the visibility of hidden files/folders