1
2
3
4 """
5 Checkm
6 ======
7
8 Implementation of the Checkm specifications at http://www.cdlib.org/inside/diglib/checkm/checkmspec.html
9
10 NOTICE
11 ======
12
13 The Checkm specification on which this implementation is based is (c) 2009 UC Regents.
14
15 This implementation is released under the Apache licence
16
17 checkm - cli script
18 ===================
19
20 Usage: checkm [options] command filenames
21
22 Commands:
23
24 checkm write [checkm filename (default:checkm.txt) [filepath (default='.')]]
25 - writes a checkm manifest file to disc for the files in the given filepath.
26 Use -r to include all files under a given path in a single manifest.
27
28 checkm print [filepath (default='.')]
29 - As for 'write', but will print the manifest to the screen.
30
31 checkm multi [checkm filename (default:checkm.txt) [filepath (default='.')]]
32 - writes a checkm manifest file to disc for the files in the given filepath, recursively creating a manifest file within each subdirectory and using the '@' designation in the parent checkm files above it.
33
34 checkm check [checkm filename (default:checkm.txt)]
35 - checks the given checkm manifest against the files on disc.
36 Use -m to recursively scan through any multilevel checkm files it finds in this manifest as well.
37
38 checkm remove_multi [checkm filename (default:checkm.txt)]
39 - scans through the checkm file, recursively gathering a list of all included checkm manifests, returning the list of files.
40 Use the option '-f' or '--force' to cause the tool to try to delete these checkm files.
41
42 checkm - tool to create, check and remove checkm manifests
43
44 Options:
45 -h, --help show this help message and exit
46 -a ALG, --algorithm=ALG
47 Algorithm to use to hash files
48 -v, --verbose Log information to stdin as it goes
49 -r, --recursive Recursively scan through child directories
50 -m, --multi Recursively scan through @Checkm manifests as well
51 -f, --force Required when recursively deleting multilevel checkm
52 files - if not added, the command will lsit the files
53 it would've deleted
54
55 API documentation - TODO!
56 """
57
58 __version__ = 0.1
59
60 from checkm import *
61