Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Description, Requirements, Issues, To-Do
  • Loading branch information
gsfordham authored Oct 13, 2018
1 parent 94f0fe6 commit 2995bfe
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# python-extension-checker
Python script that checks for incorrect file extensions

<b>Description:</b>
This script will check the current directory in the terminal for files with bad filename extensions. If it comes to such a file, it will adjust the extension and then try to rename it. If the file already exists, it will loop, repeatedly creating a new time string to append to the filename, until it is ok to save (under normal circumstances, this should only be done once).

During execution, it will ask if you wish to continue, update you every 50 files, and then print the total number of files renamed and the total size of the directory.

<b>Requires:</b>
<ul>
<li><a href="https://github.com/ahupp/python-magic">python-magic</a></li>
</ul>

<b>Known Issues:</b>
<ul>
<li>Will fail, if the filename gets too long for the operating system</li>
</ul>

<b>To Do:</b>
<ol>
<li>Fix the filename length issue</li>
</ol>

0 comments on commit 2995bfe

Please sign in to comment.