dl6nm / path-tree-generator Goto Github PK

Take care of the newest features available in 3.10 not working earlier versions like Python 3.6.

Gather informations for developers and write them down in the README.md for potential collaborators.

Add the ability for the user of this package to change the characters for the human readable output string.

The constants are defined as follows:

    HR_DIR_PREFIX = "["
    HR_DIR_SUFFIX = "]"
    HR_PIPE = "│"
    HR_ELBOW = "└──"
    HR_TEE = "├──"
    HR_PIPE_PREFIX = "│   "
    HR_SPACE_PREFIX = "    "

As a user I would like to have additional optional fields, regarding a directory or file for getting more information out of a PathTree instance.

• size: total size, in bytes
• atime: time of last access
• ctime: time of last change
• mtime: time of last modification
• gid: group ID of owner
• mode: protection bits
• uid: user ID of owner

Implement a parser for reading or importing json and dict representations of a PathTree.

As a user I want to create the same directory structure in a different location as it was read and created with PathTree.
Optional it would be nice to create dummy files.

• Build process
• Test process
• Test multiple Python versions
• Add badges to README.md

I'll suggest to use a pathlib.Path type only instead of also allowing a str to set in ListEntry model. This would be more straight forward for returning only one type, instead of guessing the right one.

In case of getting relative_paths out of the model, we can then use one of the following implementations in _PathTreeGenerator:

• p.relative_to(self._root_dir), if relative_paths=True
• p.relative_to('.'), if relative_paths=False

This can makt it easier to determine the absolute or relative path of a ListEntry in PathTree(...).tree().

To keep it short and simple, change the naming of all "get_" methods to be clear in all circumstances when using this package.

This change is inspired by...

• PEP 8 - Naming Conventions
• How should I name functions that return values in Python?