Metadata-Version: 2.1
Name: pathCrawler
Version: 0.1.0
Summary: I got tired of typing more than one line to get a recursive list of pathlib.Path objects for a given directory.
Project-URL: Homepage, https://github.com/matt-manes/pathCrawler
Project-URL: Documentation, https://github.com/matt-manes/pathCrawler/docs
Project-URL: Source code, https://github.com/matt-manes/pathCrawler/src/pathCrawler
Author: Matt Manes
License-File: LICENSE.txt
Keywords: directory
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: printbuddies
Description-Content-Type: text/markdown

# pathCrawler
Small utility because I got tired of typing more than one line to get a recursive list of pathlib.Path objects for a directory.<br>
Install using:
<pre>pip install pathCrawler</pre>
<pre>python3 -m pip install pathCrawler</pre>
<br>
pathCrawler contains just three functions: crawl, getDirectorySize, and formatSize.<br>
crawl takes a starting directory and returns a recursive list of pathlib.Path objects for all files in the starting directory and its sub folders.<br>
getDirectorySize takes a directory and returns the total size in bytes of the contents of the directory.<br>
formatSize takes a number (presumed to be bytes) and returns it as a string rounded to two decimal places with the appropriate unit suffix.<br>
i.e. 
<pre>
>>> formatSize(132458)
'132.46 kb'
</pre>
