   [](https://codecov.io/gh/bestep/drive-catalog)
<!-- -->
# Drive Catalog
Library to recursively read and return file and directory information about drives and folders.
## License
drive-catalog is licensed under the
[GNU Affero General Public License v3.0](https://github.com/bestep/drive-catalog/blob/master/LICENSE)
## Installation
To install using pip:
```bash
> pip install drive-catalog
```
## Usage Example
Call the application from the command-line without parameters returns:
``` bash
> python drive_catalog
usage: main.py [-h] [--version] path [path ...]
main.py: error: the following arguments are required: path
```
Command-line help is provided by using the help directive:
```bash
> python drive_catalog --help
usage: main.py [-h] [--version] path [path ...]
Return formatted file information
positional arguments:
path The path of the drive or folder to process.
optional arguments:
-h, --help show this help message and exit
--version Show the version number and exit.
```
Call the application from the command-line with path. Note the testdrive folder
contains public domain images, audio and video.
```bash
> python drive-catalog testdrive/
Path: /Users/bestep/3_Development/drive-catalog/testdrive
Drive Info: {'name': 'testdrive', 'total_files': 47, 'portable_drive': False, 'size': 499963174912, 'free': 60009164800, 'used': 423691579392, 'create_date': '2020-07-01T08:43:48.161025-04:00'}
p /Users/bestep/3_Development/drive-catalog/testdrive
File Info: [{'name': 'coffee_beans_coffee_drink.jpg', 'size': '147.8KiB', 'size_bytes': 151326, 'type': 'Image', 'path': '/Users/bestep/3_Development/drive-catalog/testdrive/coffee_beans_coffee_drink.jpg', 'thumbnail': '', 'create_date': '2020-06-30T23:09:33.792833-04:00', 'is_directory': False}, {'name': 'OTRR_An_Evening_With_Groucho_Singles', 'size': '1.3KiB', 'size_bytes': 1312, 'type': '', 'path': '/Users/bestep/3_Development/drive-catalog/testdrive/OTRR_An_Evening_With_Groucho_Singles', 'thumbnail': '', 'create_date': '2020-06-30T23:09:34.153570-04:00', 'is_directory': True}, {'name': 'new_york_skyline_usa.jpg', 'size': '141.2KiB', 'size_bytes': 144612, 'type': 'Image', 'path': '/Users/bestep/3_Development/drive-catalog/testdrive/new_york_skyline_usa.jpg', 'thumbnail': '', 'create_date': '2020-06-30T23:09:33.793437-04:00', 'is_directory': False},...]
```
