fck/README.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

# fck - A simple checksum utility that just works
File checker (fck) is a python wrapper for various checksum functions (though right now it only supports CRC32).
It's goal is to make verifying large amounts of files both easier and faster.
## Features
- Process/check multiple files at once.
- Automatically find expected checksums
- Quickly find faulty files.
- (Not yet) easily extendable
## Syntax
```
fck --help
usage: fck [-h] [-b] [-p PROCESSES] [-c CHECKSFV] [files [files ...]]
Calculate CRC32 of files
positional arguments:
files files and folders to process
optional arguments:
-h, --help show this help message and exit
-b, --bigfiles parse files that exceed your memory limit
-p PROCESSES, --processes PROCESSES
-c CHECKSFV, --checksfv CHECKSFV
```
## Dependencies
- >= Python3.8
- zlib // used to calculate CRC32 sums
## Roadmap
### 0.1
- [ ] Context based selection of apropriate checksum type.
- [ ] Define and document project/class structure.
- [ ] Support reading/writing '.sfv' files.
- [ ] Add Tests.
### 0.2
- [ ] Dehardcode various CRC32 specific functionalities.
- [ ] Implement propper logging.
- [ ] Implement other common checksum types.
- [ ] Write a comprehensive documentation.
### Future
- [ ] More and better error (and memory) handling.
- [ ] Better logging/output control.
- [ ] Add an optional GUI.
- [ ] Package application for Windows/Mac/Linux (maybe)