Marty/papis-extract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feat: Allow cli option for template choice

Browse source
This commit is contained in:
Marty Oehme 2023-09-19 18:30:18 +02:00
parent 9674592a9f
commit cbe2e7cb03
Signed by: Marty
GPG key ID: EDBF2ED917B2EF6A
1 changed files with 29 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
papis_extract/__init__.py
View file

@ -9,7 +9,7 @@ from papis.document import Document
from papis_extract import extractor, exporter from papis_extract import extractor, exporter
from papis_extract.annotation_data import AnnotatedDocument from papis_extract.annotation_data import AnnotatedDocument
from papis_extract.templating import Markdown from papis_extract.templating import Csv, Markdown, Templating
logger = papis.logging.get_logger(__name__) logger = papis.logging.get_logger(__name__)
@ -29,17 +29,24 @@ papis.config.register_default_settings(DEFAULT_OPTIONS)
@click.help_option("-h", "--help") @click.help_option("-h", "--help")
@papis.cli.query_argument() @papis.cli.query_argument()
@papis.cli.doc_folder_option() @papis.cli.doc_folder_option()
@papis.cli.git_option(help="Add changes made to the notes files") @papis.cli.git_option(help="Commit changes made to the notes files.")
@papis.cli.all_option() @papis.cli.all_option()
@click.option(
"--manual/--no-manual",
"-m",
help="Open each note in editor for manual editing after extracting its annotations",
)
@click.option( @click.option(
"--write/--no-write", "--write/--no-write",
"-w", "-w",
help="Do not write annotations to notes only print results to stdout", help="Do not write annotations to notes only print results to stdout.",
)
@click.option(
"--manual/--no-manual",
"-m",
help=
"Open each note in editor for manual editing after extracting its annotations.",
)
@click.option(
"--template",
"-t",
type=click.Choice(["markdown", "csv"], case_sensitive=False),
help="Choose an output template to format annotations with.",
) )
def main( def main(
query: str, query: str,
@ -53,17 +60,19 @@ def main(
doc_folder: str, doc_folder: str,
manual: bool, manual: bool,
write: bool, write: bool,
template: str,
git: bool, git: bool,
) -> None: ) -> None:
"""Extract annotations from any pdf document """Extract annotations from any pdf document.
The extract plugin allows manual or automatic extraction of all annotations The extract plugin allows manual or automatic extraction of all annotations
contained in the pdf documents belonging to entries of the pubs library. contained in the pdf documents belonging to entries of the papis library.
It can write those changes to stdout or directly create and update notes It can write those changes to stdout or directly create and update notes
for papis documents. for papis documents.
It adds a `papis extract` subcommand through which it is invoked, but can It adds a `papis extract` subcommand through which it is invoked, but can
optionally run whenever a new document is imported for a pubs entry. optionally run whenever a new document is imported for a papis entry,
if set in the plugin configuration.
""" """
documents = papis.cli.handle_doc_folder_query_all_sort( documents = papis.cli.handle_doc_folder_query_all_sort(
query, doc_folder, sort_field=None, sort_reverse=False, _all=_all query, doc_folder, sort_field=None, sort_reverse=False, _all=_all
@ -72,7 +81,12 @@ def main(
logger.warning(papis.strings.no_documents_retrieved_message) logger.warning(papis.strings.no_documents_retrieved_message)
return return
run(documents, edit=manual, write=write, git=git) if template == "csv":
template_type = Csv()
else:
template_type = Markdown()
run(documents, edit=manual, write=write, git=git, template=template_type)
def run( def run(
@ -80,11 +94,11 @@ def run(
edit: bool = False, edit: bool = False,
write: bool = False, write: bool = False,
git: bool = False, git: bool = False,
template: Templating = Markdown(),
) -> None: ) -> None:
doc_annotations: list[AnnotatedDocument] = extractor.start(documents) doc_annotations: list[AnnotatedDocument] = extractor.start(documents)
if write: if write:
exporter.to_notes(doc_annotations, Markdown(), edit=edit, git=git) exporter.to_notes(doc_annotations, template, edit=edit, git=git)
else: else:
exporter.to_stdout(doc_annotations, Markdown()) exporter.to_stdout(doc_annotations, template)