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

Adds completion for citekeys.

Browse Source
This commit is contained in:
Olivier Mangin 2017-05-12 18:33:33 -04:00
parent a5466c940e
commit 02c11aaaea
16 changed files with 118 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pubs/commands/add_cmd.py
View File

@ -9,7 +9,7 @@ from .. import color
from .. import pretty
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('add', help='add a paper to the repository')
parser.add_argument('bibfile', nargs='?', default=None,
help='bibtex file')

2
pubs/commands/conf_cmd.py
View File

@ -3,7 +3,7 @@ from .. import config
from .. import content
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('conf',
help='open the configuration in an editor')
return parser

43
pubs/commands/doc_cmd.py
View File

@ -6,6 +6,8 @@ from .. import color
from ..uis import get_ui
from .. import content
from ..utils import resolve_citekey, resolve_citekey_list
from ..completion import CiteKeyCompletion
# doc --+- add $file $key [[-L|--link] | [-M|--move]] [-f|--force]
# +- remove $key [$key [...]] [-f|--force]
@ -13,35 +15,46 @@ from ..utils import resolve_citekey, resolve_citekey_list
# +- open $key [-w|--with $cmd]
# supplements attach, open
def parser(subparsers):
doc_parser = subparsers.add_parser('doc', help='manage the document relating to a publication')
doc_subparsers = doc_parser.add_subparsers(title='document actions', help='actions to interact with the documents',
dest='action')
def parser(subparsers, conf):
doc_parser = subparsers.add_parser(
'doc',
help='manage the document relating to a publication')
doc_subparsers = doc_parser.add_subparsers(
title='document actions', dest='action',
help='actions to interact with the documents')
doc_subparsers.required = True
add_parser = doc_subparsers.add_parser('add', help='add a document to a publication')
add_parser.add_argument('-f', '--force', action='store_true', dest='force', default=False,
help='force overwriting an already assigned document')
help='force overwriting an already assigned document')
add_parser.add_argument('document', nargs=1, help='document file to assign')
add_parser.add_argument('citekey', nargs=1, help='citekey of the publication')
add_parser.add_argument('citekey', nargs=1, help='citekey of the publication'
).completer = CiteKeyCompletion(conf)
add_exclusives = add_parser.add_mutually_exclusive_group()
add_exclusives.add_argument('-L', '--link', action='store_false', dest='link', default=False,
help='do not copy document files, just create a link')
add_exclusives.add_argument('-M', '--move', action='store_true', dest='move', default=False,
help='move document instead of of copying (ignored if --link)')
add_exclusives.add_argument(
'-L', '--link', action='store_false', dest='link', default=False,
help='do not copy document files, just create a link')
add_exclusives.add_argument(
'-M', '--move', action='store_true', dest='move', default=False,
help='move document instead of of copying (ignored if --link)')
remove_parser = doc_subparsers.add_parser('remove', help='remove assigned documents from publications')
remove_parser.add_argument('citekeys', nargs='+', help='citekeys of the publications')
remove_parser.add_argument('-f', '--force', action='store_true', dest='force', default=False,
help='force removing assigned documents')
remove_parser.add_argument('citekeys', nargs='+', help='citekeys of the publications'
).completer = CiteKeyCompletion(conf)
remove_parser.add_argument('-f', '--force', action='store_true', dest='force',
default=False,
help='force removing assigned documents')
# favor key+ path over: key
export_parser = doc_subparsers.add_parser('export', help='export assigned documents to given path')
export_parser.add_argument('citekeys', nargs='+', help='citekeys of the documents to export')
export_parser.add_argument('citekeys', nargs='+',
help='citekeys of the documents to export'
).completer = CiteKeyCompletion(conf)
export_parser.add_argument('path', nargs=1, help='directory to export the files to')
open_parser = doc_subparsers.add_parser('open', help='open an assigned document')
open_parser.add_argument('citekey', nargs=1, help='citekey of the document to open')
open_parser.add_argument('citekey', nargs=1, help='citekey of the document to open'
).completer = CiteKeyCompletion(conf)
open_parser.add_argument('-w', '--with', dest='cmd', help='command to open the file with')
return doc_parser

18
pubs/commands/edit_cmd.py
View File

@ -4,15 +4,19 @@ from .. import repo
from ..uis import get_ui
from ..endecoder import EnDecoder
from ..utils import resolve_citekey
from ..completion import CiteKeyCompletion
def parser(subparsers):
parser = subparsers.add_parser('edit',
help='open the paper bibliographic file in an editor')
parser.add_argument('-m', '--meta', action='store_true', default=False,
help='edit metadata')
parser.add_argument('citekey',
help='citekey of the paper')
def parser(subparsers, conf):
parser = subparsers.add_parser(
'edit',
help='open the paper bibliographic file in an editor')
parser.add_argument(
'-m', '--meta', action='store_true', default=False,
help='edit metadata')
parser.add_argument(
'citekey',
help='citekey of the paper').completer = CiteKeyCompletion(conf)
return parser

7
pubs/commands/export_cmd.py
View File

@ -4,12 +4,15 @@ from .. import repo
from ..uis import get_ui
from .. import endecoder
from ..utils import resolve_citekey_list
from ..completion import CiteKeyCompletion
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('export', help='export bibliography')
# parser.add_argument('-f', '--bib-format', default='bibtex',
# help='export format')
parser.add_argument('citekeys', nargs='*', help='one or several citekeys')
parser.add_argument('citekeys', nargs='*', help='one or several citekeys'
).completer = CiteKeyCompletion(conf)
return parser

2
pubs/commands/import_cmd.py
View File

@ -11,7 +11,7 @@ from ..uis import get_ui
from ..content import system_path, read_text_file
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('import',
help='import paper(s) to the repository')
parser.add_argument('bibpath',

3
pubs/commands/init_cmd.py
View File

@ -9,7 +9,8 @@ from ..repo import Repository
from ..content import system_path, check_directory
from .. import config
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('init',
help="initialize the pubs directory")
parser.add_argument('-p', '--pubsdir', default=None,

2
pubs/commands/list_cmd.py
View File

@ -10,7 +10,7 @@ class InvalidQuery(ValueError):
pass
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('list', help="list papers")
parser.add_argument('-k', '--citekeys-only', action='store_true',
default=False, dest='citekeys',

10
pubs/commands/note_cmd.py
View File

@ -2,19 +2,19 @@ from .. import repo
from .. import content
from ..uis import get_ui
from ..utils import resolve_citekey
from ..completion import CiteKeyCompletion
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('note',
help='edit the note attached to a paper')
help='edit the note attached to a paper')
parser.add_argument('citekey',
help='citekey of the paper')
help='citekey of the paper'
).completer = CiteKeyCompletion(conf)
return parser
def command(conf, args):
"""
"""
ui = get_ui()
rp = repo.Repository(conf)

7
pubs/commands/remove_cmd.py
View File

@ -3,13 +3,16 @@ from .. import color
from ..uis import get_ui
from ..utils import resolve_citekey_list
from ..p3 import ustr
from ..completion import CiteKeyCompletion
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('remove', help='removes a publication')
parser.add_argument('-f', '--force', action='store_true', default=None,
help="does not prompt for confirmation.")
parser.add_argument('citekeys', nargs='+',
help="one or several citekeys")
help="one or several citekeys"
).completer = CiteKeyCompletion(conf)
return parser

18
pubs/commands/rename_cmd.py
View File

@ -2,13 +2,15 @@ from ..uis import get_ui
from .. import color
from .. import repo
from ..utils import resolve_citekey
from ..completion import CiteKeyCompletion
def parser(subparsers):
parser = subparsers.add_parser('rename', help='rename the citekey of a repository')
parser.add_argument('citekey',
help='current citekey')
parser.add_argument('new_citekey',
help='new citekey')
def parser(subparsers, conf):
parser = subparsers.add_parser('rename',
help='rename the citekey of a repository')
parser.add_argument('citekey', help='current citekey'
).completer = CiteKeyCompletion(conf)
parser.add_argument('new_citekey', help='new citekey')
return parser
@ -26,7 +28,7 @@ def command(conf, args):
paper = rp.pull_paper(key)
rp.rename_paper(paper, args.new_citekey)
ui.message("The '{}' citekey has been renamed into '{}'".format(
color.dye_out(args.citekey, 'citekey'),
color.dye_out(args.new_citekey, 'citekey')))
color.dye_out(args.citekey, 'citekey'),
color.dye_out(args.new_citekey, 'citekey')))
rp.close()

5
pubs/commands/tag_cmd.py
View File

@ -24,12 +24,13 @@ from ..uis import get_ui
from .. import pretty
from .. import color
from ..utils import resolve_citekey
from ..completion import CiteKeyCompletion
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('tag', help="add, remove and show tags")
parser.add_argument('citekeyOrTag', nargs='?', default=None,
help='citekey or tag.')
help='citekey or tag.').completer = CiteKeyCompletion(conf)
parser.add_argument('tags', nargs='?', default=None,
help='If the previous argument was a citekey, then '
'a list of tags separated by a +.')

3
pubs/commands/websearch_cmd.py
View File

@ -3,7 +3,8 @@ import urllib
from ..uis import get_ui
def parser(subparsers):
def parser(subparsers, conf):
parser = subparsers.add_parser('websearch',
help="launch a search on Google Scholar")
parser.add_argument("search_string", nargs = '*',

38
pubs/completion.py Normal file
View File

@ -0,0 +1,38 @@
from . import repo
try:
import argcomplete
except ModuleNotFoundError:
class FakeModule:
@staticmethod
def _fun(**kwargs):
pass
def __getattr__(self, _):
return self._fun
argcomplete = FakeModule()
def autocomplete(parser):
argcomplete.autocomplete(parser)
class BaseCompleter(object):
def __init__(self, conf):
self.conf = conf
def __call__(self, **kwargs):
try:
return self._complete(**kwargs)
except Exception as e:
argcomplete.warn(e)
class CiteKeyCompletion(BaseCompleter):
def _complete(self, **kwargs):
rp = repo.Repository(self.conf)
return rp.citekeys

11
pubs/pubs_cmd.py
View File

@ -7,10 +7,7 @@ from . import commands
from . import update
from . import plugins
from .__init__ import __version__
try:
import argcomplete
except ModuleNotFoundError:
argcomplete = None
from .completion import autocomplete
CORE_CMDS = collections.OrderedDict([
@ -77,7 +74,7 @@ def execute(raw_args=sys.argv):
# Populate the parser with core commands
for cmd_name, cmd_mod in CORE_CMDS.items():
cmd_parser = cmd_mod.parser(subparsers)
cmd_parser = cmd_mod.parser(subparsers, conf)
cmd_parser.set_defaults(func=cmd_mod.command)
# Extend with plugin commands
@ -85,8 +82,8 @@ def execute(raw_args=sys.argv):
for p in plugins.get_plugins().values():
p.update_parser(subparsers)
if argcomplete is not None:
argcomplete.autocomplete(parser)
# Eventually autocomplete
autocomplete(parser)
# Parse and run appropriate command
args = parser.parse_args(remaining_args)
args.prog = "pubs" # FIXME?

2
readme.md
View File

@ -26,7 +26,7 @@ Alternatively Arch Linux users can also use the [pubs-git](https://aur.archlinux
## Getting started
Create your library (by default, goes to '~/.pubs/').
Create your library (by default, goes to `~/.pubs/`).
pubs init