WARNING

This project has the same functionality of my project reportFile. So, any other updated of this project is postponed until either the project will be joined.

ListFiles

---

This application builds tow report file, by passing an absolute or relative path:

• report CSV with all the files inside the directory. The data are:

• path

• name of the file

• dimension in byte

• extension

• date of creation or last update

• report with all the files and, for every of these, a table with the data of the (probable) duplicates. The data are:

• complete path

• dimsione in byte

• date fo creation of last update

BugFix

Future

• problem with IndexError, not better identified
• the name of the printed file has to join to the extension

Next

• The input arguments have to be validated before the elaboration

Running

• None

Past

• fix the run

Features

Future

• Write a report with some filter in input (e.g. only files with a particural extension, only files after a date etc)
• Write a report with all the documents or images or video
• Change the name and url of the Github repository
• Show the directories with no elements

Next

• Fix the style of the files and the classes as PEP8

Running

• Write the file of Contributing as this

Past

• The project is structured for CI in Travis
• The directory of the source has the same name of the application, not src
• The directory of the source has the classes with no unit test
• The classes with unit test are moved inside the module of test (an idea of mine to coupling stronger test and source code)

Status CI Integration

I use Travis

Getting started

Prerequisites

• Python 3.0+
• pip
• pytest

Installing

• Clone the project with git_clone (or download directly it)
• Have fun!

Running the tests

• I use pytest framework. In the modul inside tests directory, I put also the classes from typical listfiles directory (I prefer to have class and test in the same class).
• Every unit test is declared inside the class, because for me test and implementation musto go together (highly coupled)

Break down into to end to end tests

No indications

Coding styles sheets

Please read the file CONTRIBUTING.md

Deployment

• Package in PyPi
• Run >>> python Main.py $PATH_OF_ROOT_DIRECTORY

Built with:

• ViM - one of the best text editor I know
• pytest - mature and full-featured Python testing tool, more advanced than unittest

Contributing

Please read the Contributing.md for the details about the code of conduct and the process for submitting pull requests.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Alessandro Puzielli (creator) - Alepuzio

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• PurpleBooth to publish an excellent template of README that I used in this project
• Yegor256 to write the post Elegant READMEs about the README file and the An Open Code Base Is Not Yet an Open Source Project for the Open Source projects