aselimov
/
pubs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'develop' into texnote

Browse Source
main
Fabien Benureau 12 years ago
parent 014234b159 5d5777fb5f
commit 69f1fad7e9
5 changed files with 139 additions and 73 deletions
Show Stats Download Patch File Download Diff File

68
CODESTYLE.md
Unescape View File

@ -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.

112
pit
Unescape View File

@ -5,16 +5,26 @@ pit : python issue tracker.
pit is a simple issue tracker written in python pit is a simple issue tracker written in python
""" """
__version__ = '0.3' from __future__ import print_function
__version__ = '0.4'
import sys, os import sys, os
import shutil import shutil
import ConfigParser
from hashlib import sha1 from hashlib import sha1
import StringIO
import subprocess import subprocess
import datetime 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 # Searching for the pit dir
pitdir = None pitdir = None
@ -30,9 +40,9 @@ def find_pitdir():
curdir = '' curdir = ''
else: else:
curdir = os.path.split(curdir)[0] curdir = os.path.split(curdir)[0]
if pitdir is None: 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) exit(0)
# Reading Writing issues # Reading Writing issues
@ -53,13 +63,14 @@ def get_author():
author = author.strip('\n') author = author.strip('\n')
mail = mail.strip('\n') mail = mail.strip('\n')
return author, mail return author, mail
except OSError, subprocess.CalledProcessError: except OSError as xxx_todo_changeme:
subprocess.CalledProcessError = xxx_todo_changeme
return 'anonymous', 'unknow' return 'anonymous', 'unknow'
def get_issue_date(issue): def get_issue_date(issue):
try: try:
return datetime.datetime.strptime(issue.get('header', 'date'), '%Y-%m-%d at %H:%M UCT') 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) return datetime.datetime(2012, 8, 7, 0, 36, 32, 0)
def issue_file(digest): def issue_file(digest):
@ -80,7 +91,7 @@ def find_issue_file(digest):
def read_issue(digest): def read_issue(digest):
f = find_issue_file(digest) f = find_issue_file(digest)
if os.path.exists(f): if os.path.exists(f):
issue = ConfigParser.ConfigParser() issue = configparser.ConfigParser()
issue.read(f) issue.read(f)
return issue return issue
else: else:
@ -121,7 +132,7 @@ grey = '\033[0;37m'
bblack = '\033[1;30m' bblack = '\033[1;30m'
bred = '\033[1;31m' bred = '\033[1;31m'
bgreen = '\033[1;32m' bgreen = '\033[1;32m'
byellow = '\033[1;33m' byellow = '\033[1;33m'
bblue = '\033[1;34m' bblue = '\033[1;34m'
bpurple = '\033[1;35m' bpurple = '\033[1;35m'
bcyan = '\033[1;36m' bcyan = '\033[1;36m'
@ -149,19 +160,19 @@ def show_issues(filtered_status):
if filename.startswith('pit-'): if filename.startswith('pit-'):
issue = read_issue(filename[4:]) issue = read_issue(filename[4:])
status = issue.get('header', 'status') status = issue.get('header', 'status')
if filtered_status is None or status in filtered_status: if filtered_status is None or status in filtered_status:
relevant_issues.append((get_issue_date(issue), oneline(issue))) relevant_issues.append((get_issue_date(issue), oneline(issue)))
relevant_issues.sort() relevant_issues.sort()
for _, line in relevant_issues: for _, line in relevant_issues:
#print _ #print _
print line print(line)
# Commands # Commands
def init_cmd(): def init_cmd():
"""Create a .pit directory""" """Create a .pit directory"""
pitdir = os.getcwd() + '/.pit' pitdir = os.getcwd() + '/.pit'
print "initializing pit in %s" % (pitdir,) print("initializing pit in %s" % (pitdir,))
if not os.path.exists(pitdir): if not os.path.exists(pitdir):
os.makedirs(pitdir) os.makedirs(pitdir)
@ -170,38 +181,38 @@ def add_cmd(title):
# finding type # finding type
t = None t = None
while t not in set(['b', 'f', 't', '', 'bug', 'feature', 'task']): 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() sys.stdout.flush()
t = raw_input() t = input()
if t == '': if t == '':
t = 'b' t = 'b'
extend = {'b':'bug', 'f':'feature', 't':'task'} extend = {'b':'bug', 'f':'feature', 't':'task'}
if t in extend: if t in extend:
t = extend[t] t = extend[t]
# finding the digest # finding the digest
issue = setup_issue('', title, t) issue = setup_issue('', title, t)
s = StringIO.StringIO() s = io.StringIO()
issue.write(s) issue.write(s)
digest = sha1digest(s.getvalue()) digest = sha1digest(s.getvalue())
# creating the issue values # creating the issue values
filepath = issue_file(digest) filepath = issue_file(digest)
if os.path.exists(filepath): 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) exit(1)
issue.set('header', 'id', digest) issue.set('header', 'id', digest)
issue.set('eventlog', 'opened[0]', 'opened the {} by {}'.format(issue.get('header', 'date'), issue.set('eventlog', 'opened[0]', 'opened the {} by {}'.format(issue.get('header', 'date'),
issue.get('header', 'author'))) issue.get('header', 'author')))
# writing the issue on file # writing the issue on file
try: try:
with open(filepath, 'w') as f: with open(filepath, 'w') as f:
issue.write(f) issue.write(f)
except IOError as e: 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): def close_cmd(digest):
"""Close issue n""" """Close issue n"""
@ -209,25 +220,25 @@ def close_cmd(digest):
status = issue.get('header', 'status') status = issue.get('header', 'status')
digest = issue.get('header', 'id')[:sha1_length] digest = issue.get('header', 'id')[:sha1_length]
if status == 'closed': 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: else:
issue.set('header','status','closed') issue.set('header','status','closed')
now = datetime.datetime.utcnow() now = datetime.datetime.utcnow()
author, mail = get_author() author, mail = get_author()
try: try:
issue.add_section('eventlog') issue.add_section('eventlog')
except ConfigParser.DuplicateSectionError: except ConfigParser.DuplicateSectionError:
pass pass
issue.set('eventlog', issue.set('eventlog',
'closed[{}]'.format(len(issue.options('eventlog'))), 'closed[{}]'.format(len(issue.options('eventlog'))),
'closed the {} at {}(UCT) by {}'.format(now.date().isoformat(), now.time().strftime("%H:%M"), author)) 'closed the {} at {}(UCT) by {}'.format(now.date().isoformat(), now.time().strftime("%H:%M"), author))
try: try:
with open(issue_file(digest), 'w') as f: with open(issue_file(digest), 'w') as f:
issue.write(f) issue.write(f)
except IOError as e: 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(): def open_cmd():
"""Show opened issues""" """Show opened issues"""
@ -242,18 +253,18 @@ def all_cmd():
show_issues(None) show_issues(None)
def install_cmd(): def install_cmd():
"""Install command on the system""" """Install command on the system"""
print 'File to install :', __file__ print('File to install :', __file__)
default = '/usr/local/bin' 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() sys.stdout.flush()
path = raw_input() path = input()
if path == '': if path == '':
path = default path = default
if not os.path.exists(path): 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: else:
if os.path.exists(path+'/pit'): if os.path.exists(path+'/pit'):
if os.path.samefile(path+'/pit', __file__): if os.path.samefile(path+'/pit', __file__):
@ -267,7 +278,7 @@ def update_cmd():
if filename.startswith('pit00'): if filename.startswith('pit00'):
issue = ConfigParser.ConfigParser() issue = ConfigParser.ConfigParser()
issue.read(pitdir + '/' + filename) issue.read(pitdir + '/' + filename)
s = StringIO.StringIO() s = io.StringIO()
issue.write(s) issue.write(s)
digest = sha1digest(s.getvalue()) digest = sha1digest(s.getvalue())
@ -275,7 +286,7 @@ def update_cmd():
assert not os.path.exists(filepath) assert not os.path.exists(filepath)
issue.set('header', 'id', digest) issue.set('header', 'id', digest)
with open(filepath, 'w') as f: with open(filepath, 'w') as f:
issue.write(f) issue.write(f)
# Handling command line arguments # Handling command line arguments
@ -299,7 +310,7 @@ manual = """pit manual
pit is designed to be simple, self-contained, and compatible with git branching. pit is designed to be simple, self-contained, and compatible with git branching.
{b}BASIC USAGE{e} {b}BASIC USAGE{e}
$ {b}pit init{e} $ {b}pit init{e}
initializing pit in /Users/fabien/Perso/sync/projects/pit/.pit initializing pit in /Users/fabien/Perso/sync/projects/pit/.pit
$ {b}pit add{e} 'bug description' $ {b}pit add{e} 'bug description'
@ -309,7 +320,7 @@ pit is designed to be simple, self-contained, and compatible with git branching.
0001 b [ open ] bug description 0001 b [ open ] bug description
$ {b}pit close 1{e} $ {b}pit close 1{e}
$ {b}pit open{e} $ {b}pit open{e}
$ {b}pit closed{e} $ {b}pit closed{e}
0001 b [closed] bug description 0001 b [closed] bug description
{b}DISTRIBUTION{e} {b}DISTRIBUTION{e}
@ -321,18 +332,18 @@ pit is designed to be simple, self-contained, and compatible with git branching.
Each issue is stored in its own file in the .pit directory. Each issue is stored in its own file in the .pit directory.
At creation, the checksum of the file is computed, and it designates the issue At creation, the checksum of the file is computed, and it designates the issue
for there on. This is particularly useful when using pit under git : collision for there on. This is particularly useful when using pit under git : collision
between issues created in different branch are vanishingly unlikely, and when between issues created in different branch are vanishingly unlikely, and when
they happen, overwhelming chances are the bug are exactly the same. they happen, overwhelming chances are the bug are exactly the same.
"If all 6.5 billion humans on Earth were programming, and every second, each one "If all 6.5 billion humans on Earth were programming, and every second, each one
was producing code that was the equivalent of the entire Linux kernel history was producing code that was the equivalent of the entire Linux kernel history
(1 million Git objects) and pushing it into one enormous Git repository, it (1 million Git objects) and pushing it into one enormous Git repository, it
would take 5 years until that repository contained enough objects to have a 50%% would take 5 years until that repository contained enough objects to have a 50%%
probability of a single SHA-1 object collision." -- Pro Git book. probability of a single SHA-1 object collision." -- Pro Git book.
""".format(b=bold, e=end) """.format(b=bold, e=end)
if len(sys.argv) == 1 or len(sys.argv) > 3: if len(sys.argv) == 1 or len(sys.argv) > 3:
print usage print(usage)
exit(0) exit(0)
cmd = sys.argv[1] cmd = sys.argv[1]
@ -341,15 +352,15 @@ if cmd not in ['init', 'install', 'man', 'version']:
if len(sys.argv) == 2: if len(sys.argv) == 2:
if cmd not in ['init', 'open', 'install', 'man', 'version', 'closed', 'all', 'update']: if cmd not in ['init', 'open', 'install', 'man', 'version', 'closed', 'all', 'update']:
print usage print(usage)
elif cmd == 'init': elif cmd == 'init':
init_cmd() init_cmd()
elif cmd == 'install': elif cmd == 'install':
install_cmd() install_cmd()
elif cmd == 'man': elif cmd == 'man':
print manual print(manual)
elif cmd == 'version': elif cmd == 'version':
print __version__ print(__version__)
elif cmd == 'open': elif cmd == 'open':
open_cmd() open_cmd()
elif cmd == 'closed': elif cmd == 'closed':
@ -360,11 +371,10 @@ if len(sys.argv) == 2:
update_cmd() update_cmd()
if len(sys.argv) == 3: if len(sys.argv) == 3:
if cmd not in ['add', 'close']: if cmd not in ['add', 'close']:
print usage print(usage)
elif cmd == 'add': elif cmd == 'add':
title = sys.argv[2] title = sys.argv[2]
add_cmd(title) add_cmd(title)
elif cmd == 'close': elif cmd == 'close':
digest = sys.argv[2] digest = sys.argv[2]
close_cmd(digest) close_cmd(digest)

2
tests/data/pagerank.bib
Unescape View File

@ -7,7 +7,7 @@
type = {Technical Report}, type = {Technical Report},
publisher = {Stanford InfoLab}, publisher = {Stanford InfoLab},
year = {1999}, year = {1999},
journal = {Stanford InfoLab}, institution = {Stanford InfoLab},
url = {http://ilpubs.stanford.edu:8090/422/}, 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.} 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.}
} }

14
tests/data/pagerank.bib.bak
Unescape View File

@ -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.}
}

16
tests/test.sh
Unescape View File

@ -1,9 +1,11 @@
#!/usr/bin/env bash #!/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 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/*;

Write Preview
Loading…
Cancel
Save