summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2018-05-05 10:49:51 +0200
committerLars-Dominik Braun <lars@6xq.net>2018-05-05 10:51:39 +0200
commit2af6c9c180230cfe59bc6a806f5d3c6f3985f57a (patch)
tree413d687c2bc390b56d4ed93c24f78b64765b7d9c
parentfd442b1f8ddc6f9f91aae902cf7018567e818a61 (diff)
downloadcrocoite-2af6c9c180230cfe59bc6a806f5d3c6f3985f57a.tar.gz
crocoite-2af6c9c180230cfe59bc6a806f5d3c6f3985f57a.tar.bz2
crocoite-2af6c9c180230cfe59bc6a806f5d3c6f3985f57a.zip
Rename command line tools
Move contrib/ scripts to .tools and add entry points to setup.py, rename crocoite-standalone to crocoite-grab.
-rwxr-xr-xcontrib/extractScreenshot.py54
-rw-r--r--[-rwxr-xr-x]crocoite/tools.py (renamed from contrib/mergeWarc.py)41
-rw-r--r--setup.py4
3 files changed, 37 insertions, 62 deletions
diff --git a/contrib/extractScreenshot.py b/contrib/extractScreenshot.py
deleted file mode 100755
index 80911d5..0000000
--- a/contrib/extractScreenshot.py
+++ /dev/null
@@ -1,54 +0,0 @@
-#!/usr/bin/env python3
-
-# Copyright (c) 2017 crocoite contributors
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-"""
-Extract page screenshots from a WARC generated by crocoite into files
-"""
-
-import shutil, sys, re, os
-from warcio.archiveiterator import ArchiveIterator
-
-if __name__ == '__main__':
- import argparse
-
- parser = argparse.ArgumentParser(description='Extract screenshots.')
- parser.add_argument('-f', '--force', action='store_true', help='Overwrite existing files')
- parser.add_argument('input', type=argparse.FileType ('rb'), help='Input WARC')
- parser.add_argument('prefix', help='Output file prefix')
-
- args = parser.parse_args()
-
- screenshotRe = re.compile (r'^urn:crocoite:screenshot-(\d+)-(\d+).png$', re.I)
- with args.input:
- for record in ArchiveIterator(args.input):
- uri = record.rec_headers.get_header('WARC-Target-URI')
- if record.rec_type == 'resource':
- m = screenshotRe.match (uri)
- xoff, yoff = m.groups ()
- if m:
- outpath = '{}-{}-{}.png'.format (args.prefix, xoff, yoff)
- if args.force or not os.path.exists (outpath):
- with open (outpath, 'wb') as out:
- shutil.copyfileobj (record.raw_stream, out)
- else:
- print ('not overwriting {}'.format (outpath))
-
diff --git a/contrib/mergeWarc.py b/crocoite/tools.py
index 9442010..bc92f8f 100755..100644
--- a/contrib/mergeWarc.py
+++ b/crocoite/tools.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
# Copyright (c) 2018 crocoite contributors
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -21,16 +19,18 @@
# THE SOFTWARE.
"""
-Merge multiple WARC files into a single file, writing revisit records for items
-which occur multiple times
+Misc tools
"""
-import shutil, sys, re, os, logging
+import shutil, sys, re, os, logging, argparse
from warcio.archiveiterator import ArchiveIterator
from warcio.warcwriter import WARCWriter
-if __name__ == '__main__':
- import argparse
+def mergeWarc ():
+ """
+ Merge multiple WARC files into a single file, writing revisit records for
+ items which occur multiple times
+ """
parser = argparse.ArgumentParser(description='Merge WARCs, reads filenames from stdin.')
parser.add_argument('--verbose', '-v', action='store_true')
@@ -68,3 +68,30 @@ if __name__ == '__main__':
writer.write_record (record)
logging.info ('Wrote {} unique records, {} revisits'.format (unique, revisit))
+def extractScreenshot ():
+ """
+ Extract page screenshots from a WARC generated by crocoite into files
+ """
+
+ parser = argparse.ArgumentParser(description='Extract screenshots.')
+ parser.add_argument('-f', '--force', action='store_true', help='Overwrite existing files')
+ parser.add_argument('input', type=argparse.FileType ('rb'), help='Input WARC')
+ parser.add_argument('prefix', help='Output file prefix')
+
+ args = parser.parse_args()
+
+ screenshotRe = re.compile (r'^urn:crocoite:screenshot-(\d+)-(\d+).png$', re.I)
+ with args.input:
+ for record in ArchiveIterator(args.input):
+ uri = record.rec_headers.get_header('WARC-Target-URI')
+ if record.rec_type == 'resource':
+ m = screenshotRe.match (uri)
+ xoff, yoff = m.groups ()
+ if m:
+ outpath = '{}-{}-{}.png'.format (args.prefix, xoff, yoff)
+ if args.force or not os.path.exists (outpath):
+ with open (outpath, 'wb') as out:
+ shutil.copyfileobj (record.raw_stream, out)
+ else:
+ print ('not overwriting {}'.format (outpath))
+
diff --git a/setup.py b/setup.py
index 7b77833..128621b 100644
--- a/setup.py
+++ b/setup.py
@@ -17,7 +17,9 @@ setup(
],
entry_points={
'console_scripts': [
- 'crocoite-standalone = crocoite.cli:main',
+ 'crocoite-grab = crocoite.cli:main',
+ 'crocoite-merge-warc = crocoite.tools:mergeWarc',
+ 'crocoite-extract-screenshot = crocoite.tools:extractScreenshot',
],
},
package_data={