nothing

CODESTYLE.md

@@ -0,0 +1,68 @@
+Generally
+=========
+
+Use use regular coding style:
+http://www.python.org/dev/peps/pep-0008/
+http://google-styleguide.googlecode.com/
+
+One can break those rules if the situation requires it. Keep it contained.
+
+
+Some specific rules for this package :
+
+Git
+===
+
+This project use git-flow {nvie.com/posts/a-successful-git-branching-model}
+as a model for branches management. In particular :
+- master is for release only
+- when you commit to develop, run nosetests before. All tests should pass.
+- in feature/branches, you do whatever you want.
+- when developping a new feature, write tests for it.
+
+
+Alignement
+==========
+
+We strive for code clarity first, and then conformance to pep-8.
+As such, any code alignement that make the code clearer, easier to use,
+edit and debug takes precedence over proper spacing.
+
+
+Strings
+=======
+
+For literals strings, ' is preferred to ", but use " when the string contains '.
+
+yes: "run the command 'flake8' before committing"
+no : 'run the command \'flake8\' before committing'
+
+
+Use '.format' syntax for strings, and '+' only when the use calls it.
+Don't mix and match.
+
+yes: s = color + s + end
+yes: '{}: file {} could not be read'.format(errorname, filepath)
+no : errorname + ': file {} could not be read'.format(filepath)
+
+
+Names
+=====
+
+Avoid at all cost to name a variable like a module from the package, a
+dependency or the standart lib.
+This breaks coherence across the code, makes it harder to read.
+Change either the module or variable name, I don't care.
+
+
+Function that have only local uses should be preceded by an underscore.
+
+yes: def _auxiliary_local_fun():
+         pass
+no : def auxiliary_local_fun():
+         pass
+
+These functiona won't be imported automatically with the module.
+It keeps the interface clean, makes occasional hacks explicit, and inform other
+developers that theses functions may need special care when uses outside their
+natural habitat.

pit

@@ -5,16 +5,26 @@ pit : python issue tracker.
 
 pit is a simple issue tracker written in python
 """
-__version__ = '0.3'
+from __future__ import print_function
+
+__version__ = '0.4'
 
 import sys, os
 import shutil
-import ConfigParser
+
 from hashlib import sha1
-import StringIO
 import subprocess
 import datetime
 
+if sys.version_info[0] == 2:
+    import ConfigParser as configparser
+    import StringIO as io
+    input = raw_input
+else:
+    import configparser
+    import io
+
+
 # Searching for the pit dir
 
 pitdir = None
@@ -32,7 +42,7 @@ def find_pitdir():
             curdir = os.path.split(curdir)[0]
 
     if pitdir is None:
-        print 'No pit repo found in this directory or in any parent directory.'
+        print('No pit repo found in this directory or in any parent directory.')
         exit(0)
 
 # Reading Writing issues
@@ -53,13 +63,14 @@ def get_author():
         author = author.strip('\n')
         mail   = mail.strip('\n')
         return author, mail
-    except OSError, subprocess.CalledProcessError:
+    except OSError as xxx_todo_changeme:
+        subprocess.CalledProcessError = xxx_todo_changeme
         return 'anonymous', 'unknow'
 
 def get_issue_date(issue):
     try:
         return datetime.datetime.strptime(issue.get('header', 'date'), '%Y-%m-%d at %H:%M UCT')
-    except ConfigParser.NoOptionError:
+    except configparser.NoOptionError:
         return datetime.datetime(2012, 8, 7, 0, 36, 32, 0)
 
 def issue_file(digest):
@@ -80,7 +91,7 @@ def find_issue_file(digest):
 def read_issue(digest):
     f = find_issue_file(digest)
     if os.path.exists(f):
-        issue = ConfigParser.ConfigParser()
+        issue = configparser.ConfigParser()
         issue.read(f)
         return issue
     else:
@@ -154,14 +165,14 @@ def show_issues(filtered_status):
     relevant_issues.sort()
     for _, line in relevant_issues:
         #print _
-        print line
+        print(line)
 
 # Commands
 
 def init_cmd():
     """Create a .pit directory"""
     pitdir = os.getcwd() + '/.pit'
-    print "initializing pit in %s" % (pitdir,)
+    print("initializing pit in %s" % (pitdir,))
     if not os.path.exists(pitdir):
         os.makedirs(pitdir)
 
@@ -170,9 +181,9 @@ def add_cmd(title):
     # finding type
     t = None
     while t not in set(['b', 'f', 't', '', 'bug', 'feature', 'task']):
-        print "bug (b), feature (f) or task (t) ? [b]: ",
+        print("bug (b), feature (f) or task (t) ? [b]: ", end=' ')
         sys.stdout.flush()
-        t = raw_input()
+        t = input()
     if t == '':
         t = 'b'
     extend = {'b':'bug', 'f':'feature', 't':'task'}
@@ -181,14 +192,14 @@ def add_cmd(title):
 
     # finding the digest
     issue = setup_issue('', title, t)
-    s = StringIO.StringIO()
+    s = io.StringIO()
     issue.write(s)
     digest = sha1digest(s.getvalue())
 
     # creating the issue values
     filepath = issue_file(digest)
     if os.path.exists(filepath):
-        print '{}error{}: an issue by this name already exists; exiting.'.format(red, end)
+        print('{}error{}: an issue by this name already exists; exiting.'.format(red, end))
         exit(1)
     issue.set('header', 'id', digest)
     issue.set('eventlog', 'opened[0]', 'opened the {} by {}'.format(issue.get('header', 'date'),
@@ -199,9 +210,9 @@ def add_cmd(title):
        with open(filepath, 'w') as f:
            issue.write(f)
     except IOError as e:
-       print 'IOError : impossible to write on issue file {:s}'.format(issue_file(digest))
+       print('IOError : impossible to write on issue file {:s}'.format(issue_file(digest)))
-       print 'Verify file permissions'
+       print('Verify file permissions')
-    print oneline(issue)
+    print(oneline(issue))
 
 def close_cmd(digest):
     """Close issue n"""
@@ -209,7 +220,7 @@ def close_cmd(digest):
     status = issue.get('header', 'status')
     digest = issue.get('header', 'id')[:sha1_length]
     if status == 'closed':
-        print "{}warning{}: issue {}{}{} already closed".format(red, end, bold, digest, end)
+        print("{}warning{}: issue {}{}{} already closed".format(red, end, bold, digest, end))
     else:
         issue.set('header','status','closed')
         now = datetime.datetime.utcnow()
@@ -226,8 +237,8 @@ def close_cmd(digest):
            with open(issue_file(digest), 'w') as f:
                issue.write(f)
         except IOError as e:
-           print 'IOError : impossible to write on issue file {:s}'.format(issue_file(digest))
+           print('IOError : impossible to write on issue file {:s}'.format(issue_file(digest)))
-           print 'Verify file permissions'
+           print('Verify file permissions')
 
 def open_cmd():
     """Show opened issues"""
@@ -244,16 +255,16 @@ def all_cmd():
 def install_cmd():
 
     """Install command on the system"""
-    print 'File to install :', __file__
+    print('File to install :', __file__)
     default = '/usr/local/bin'
-    print "Folder to install the pit command [{:s}] : ".format(default),
+    print("Folder to install the pit command [{:s}] : ".format(default), end=' ')
     sys.stdout.flush()
-    path = raw_input()
+    path = input()
     if path == '':
         path = default
 
     if not os.path.exists(path):
-        print "error: {:s} does not exist. Installation aborted.".format(path)
+        print("error: {:s} does not exist. Installation aborted.".format(path))
     else:
         if os.path.exists(path+'/pit'):
             if os.path.samefile(path+'/pit', __file__):
@@ -267,7 +278,7 @@ def update_cmd():
         if filename.startswith('pit00'):
             issue = ConfigParser.ConfigParser()
             issue.read(pitdir + '/' + filename)
-            s = StringIO.StringIO()
+            s = io.StringIO()
             issue.write(s)
             digest = sha1digest(s.getvalue())
 
@@ -332,7 +343,7 @@ pit is designed to be simple, self-contained, and compatible with git branching.
 """.format(b=bold, e=end)
 
 if len(sys.argv) == 1 or len(sys.argv) > 3:
-    print usage
+    print(usage)
     exit(0)
 
 cmd = sys.argv[1]
@@ -341,15 +352,15 @@ if cmd not in ['init', 'install', 'man', 'version']:
 
 if len(sys.argv) == 2:
     if cmd not in ['init', 'open', 'install', 'man', 'version', 'closed', 'all', 'update']:
-        print usage
+        print(usage)
     elif cmd == 'init':
         init_cmd()
     elif cmd == 'install':
         install_cmd()
     elif cmd == 'man':
-        print manual
+        print(manual)
     elif cmd == 'version':
-        print __version__
+        print(__version__)
     elif cmd == 'open':
         open_cmd()
     elif cmd == 'closed':
@@ -360,11 +371,10 @@ if len(sys.argv) == 2:
         update_cmd()
 if len(sys.argv) == 3:
     if cmd not in ['add', 'close']:
-        print usage
+        print(usage)
     elif cmd == 'add':
         title = sys.argv[2]
         add_cmd(title)
     elif cmd == 'close':
         digest = sys.argv[2]
         close_cmd(digest)
-      

tests/data/pagerank.bib

@@ -7,7 +7,7 @@
             type = {Technical Report},
        publisher = {Stanford InfoLab},
             year = {1999},
-         journal = {Stanford InfoLab},
+     institution = {Stanford InfoLab},
              url = {http://ilpubs.stanford.edu:8090/422/},
         abstract = {The importance of a Web page is an inherently subjective matter, which depends on the readers interests, knowledge and attitudes. But there is still much that can be said objectively about the relative importance of Web pages. This paper describes PageRank, a mathod for rating Web pages objectively and mechanically, effectively measuring the human interest and attention devoted to them. We compare PageRank to an idealized random Web surfer. We show how to efficiently compute PageRank for large numbers of pages. And, we show how to apply PageRank to search and to user navigation.}
 }

tests/data/pagerank.bib.bak

@@ -1,14 +0,0 @@
-@techreport{ilprints422,
-          number = {1999-66},
-           month = {November},
-          author = {Lawrence Page and Sergey Brin and Rajeev Motwani and Terry Winograd},
-            note = {Previous number = SIDL-WP-1999-0120},
-           title = {The PageRank Citation Ranking: Bringing Order to the Web.},
-            type = {Technical Report},
-       publisher = {Stanford InfoLab},
-            year = {1999},
-     institution = {Stanford InfoLab},
-             url = {http://ilpubs.stanford.edu:8090/422/},
-        abstract = {The importance of a Web page is an inherently subjective matter, which depends on the readers interests, knowledge and attitudes. But there is still much that can be said objectively about the relative importance of Web pages. This paper describes PageRank, a mathod for rating Web pages objectively and mechanically, effectively measuring the human interest and attention devoted to them. We compare PageRank to an idealized random Web surfer. We show how to efficiently compute PageRank for large numbers of pages. And, we show how to apply PageRank to search and to user navigation.}
-}
-

tests/test.sh

@@ -1,9 +1,11 @@
 #!/usr/bin/env bash
-rm -Rf .papers;
+rm -Rf paper_test/;
-papers init;
+papers init -p paper_test/;
+papers add -d data/pagerank.pdf -b data/pagerank.bib;
 papers list;
-papers add data/pagerank.pdf data/pagerank.bib;
+papers tag;
-papers list;
+papers tag Page99 network,search;
-papers open 0;
+papers tag Page99;
-papers open Page99;
+papers tag search;
-rm -Rf .papers;
+papers tag 0;
+rm -Rf paper_test/*;