mpierre9 / fileinfo Goto Github PK

Great work on the docs so far @MPierre9
I've listed out some minor changes and suggestions for your review.

Summary

• Since you describe the usage of each function maybe summarize the purpose and functionality of the library

ADD Prerequisites section

• minimum package versions, environment etc.
• ex. Python 3.6 and up

Installation

• small typo on step # 5 "Your" to "You're"

Usage

• display the result of each example
• how to execute the tests manually (if possible)

We need a way to get the MD5 digest for a file at a given path. For example, given a path like "/home/kim/mydata.txt", which contains the text The quick brown fox jumps over the lazy dog, it should return "9e107d9d372bb6826bd81d3542a419d6".

We need a way to get a filename without the path in Python for example c:/project/code/index.js return index.js

We need a way to get a files size in bytes for a given path, for example c:/project/code/index.js would return 1254 bytes

We need a function that returns the SHA1 Digest for a given path for example say we have c:/project/code/index.txt which contains sensitive password information like P@ssw0rd123 we need to retrieve the SHA1 which could be fd4e1c67a2d28fced849ee1bb76e7391b93eb12