added contrib/offline-issues

contrib/offline-issues/README.rst

@@ -0,0 +1,44 @@
+OctoHub Contib: Offline Issues
+==============================
+
+``offline-issues`` leverages OctoHub to download GitHub issues, and then
+parses them into a directory structure of symlinks based on issue
+metadata, such as labels and assignees::
+
+ all/:issue.number
+ state/:issue.state/:issue.title|slug -> ../../all/:issue.number
+ labels/:issue.label/:issue.title|slug -> ../../all/:issue.number
+ assignee/:assignee.login/:issue.title|slug -> ../../all/:issue.number
+
+Setup
+-----
+
+Once OctoHub is installed, add the ``offline issues`` parser to your path::
+
+ cd octohub
+ ln -s $(pwd)/contrib/offline-issues/parse.py $HOME/bin/octohub-parse-issues
+
+For each issue tracker or subset::
+
+ ISSUES_DIR=path/to/project/issues
+ mkdir -p $ISSUES_DIR
+
+ cd octohub
+ cp contrib/offline-issues/update.sh $ISSUES_DIR/
+ cd $ISSUES_DIR
+ 
+ # set ISSUES_URI to the desired issue listing
+ # reference: http:https://developer.github.com/v3/issues
+ vim update.sh 
+ 
+ # optional, but useful to see what has changed between updates
+ echo .raw > .gitignore
+ git init
+ git add .gitignore update.sh
+ git commit -m 'initial commit'
+ 
+ # if ISSUES_URI requires authentication
+ export OCTOHUB_TOKEN=... 
+ 
+ ./update.sh
+

contrib/offline-issues/parse.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python
+# Copyright (c) 2013 Alon Swartz <[email protected]>
+#
+# This file is part of octohub/contrib
+#
+# OctoHub is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+
+"""
+Parse local Github issues and generate directory listing
+
+Arguments:
+ issues.json Path to json encoded issues
+ outdir Path to create directory listing
+
+Options:
+ --noinit Don't initialize directory listing (use with care)
+
+Generated directory listing:
+ all/:issue.number
+ state/:issue.state/:issue.title|slug -> ../../all/:issue.number
+ labels/:issue.label/:issue.title|slug -> ../../all/:issue.number
+ assignee/:assignee.login/:issue.title|slug -> ../../all/:issue.number
+"""
+
+import re
+import os
+import sys
+import getopt
+import shutil
+import unicodedata
+
+import simplejson as json
+
+from octohub.response import parse_element
+
+def fatal(e):
+ print >> sys.stderr, 'Error: ' + str(e)
+ sys.exit(1)
+
+def usage(e=None):
+ if e:
+ print >> sys.stderr, 'Error:', e
+
+ print >> sys.stderr, 'Syntax: %s [-options] issues.json outdir' % sys.argv[0]
+ print >> sys.stderr, __doc__.strip()
+
+ sys.exit(1)
+
+def mkdir(path):
+ if not os.path.exists(path):
+ os.makedirs(path)
+
+def symlink(target, link_name):
+ if not os.path.exists(link_name):
+ mkdir(os.path.dirname(link_name))
+ os.symlink(target, link_name)
+
+def slugify(value):
+ """Normalizes string, converts to lowercase, removes non-alpha characters,
+ and converts spaces to hyphens.
+ """
+ value = unicode(value)
+ value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore')
+ value = unicode(re.sub('[^\w\s-]', '', value).strip().lower())
+ return re.sub('[-\s]+', '-', value)
+
+def output_issues(issues, outdir):
+ """Parse issues and output directory listing"""
+ for issue in issues:
+ slug = slugify(issue.title)
+
+ path = os.path.join(outdir, 'all', str(issue.number))
+ path_symlink = '../../all/%s' % str(issue.number)
+ mkdir(os.path.dirname(path))
+ file(path, 'w').write(json.dumps(issue, indent=1))
+
+ path = os.path.join(outdir, 'state', issue.state, slug)
+ symlink(path_symlink, path)
+
+ for label in issue.labels:
+ path = os.path.join(outdir, 'labels', label.name, slug)
+ symlink(path_symlink, path)
+
+ if issue.assignee:
+ path = os.path.join(outdir, 'assignee', issue.assignee.login, slug)
+ symlink(path_symlink, path)
+
+def main():
+ try:
+ opts, args = getopt.gnu_getopt(sys.argv[1:], 'h', ['help', 'noinit'])
+ except getopt.GetoptError, e:
+ usage(e)
+
+ init = True
+ for opt, val in opts:
+ if opt in ('-h', '--help'):
+ usage()
+
+ if opt == '--noinit':
+ init = False
+
+ if len(args) == 0:
+ usage()
+
+ if len(args) != 2:
+ usage('incorrect number of arguments')
+
+ infile = args[0]
+ outdir = args[1]
+
+ if not os.path.exists(infile):
+ fatal('path does not exist: %s' % infile)
+
+ if init:
+ for dir in ('state', 'labels', 'assignee'):
+ path = os.path.join(outdir, dir)
+ if os.path.exists(path):
+ shutil.rmtree(path)
+
+ issues_dict = json.loads(file(infile, 'r').read())
+ issues_parsed = parse_element(issues_dict)
+ output_issues(issues_parsed, outdir)
+
+if __name__ == "__main__":
+ main()

contrib/offline-issues/update.sh

@@ -0,0 +1,34 @@
+#!/bin/bash -e
+# Copyright (c) 2013 Alon Swartz <[email protected]>
+#
+# This file is part of octohub/contrib
+#
+# OctoHub is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+
+fatal() {
+ echo "fatal: $@" 1>&2
+ exit 1
+}
+
+ISSUES_URI=/repos/turnkeylinux/tracker/issues
+ISSUES_DIR=$(dirname $(readlink -f $0))
+
+which octohub >/dev/null || fatal "octohub not in path"
+which octohub-parse-issues >/dev/null || fatal "octohub-parse-issues not in path"
+
+mkdir -p $ISSUES_DIR/.raw
+octohub --max-pages=0 GET $ISSUES_URI state=open > $ISSUES_DIR/.raw/open.json
+octohub --max-pages=0 GET $ISSUES_URI state=closed > $ISSUES_DIR/.raw/closed.json
+
+octohub-parse-issues $ISSUES_DIR/.raw/open.json .
+octohub-parse-issues --noinit $ISSUES_DIR/.raw/closed.json .
+
+if [ -d $ISSUES_DIR/.git ]; then
+ cd $ISSUES_DIR
+ git add -A .
+ git commit -m "autocommit"
+fi
+