PAPIS-LIST(1)

NAME
papis-list - list command

This command is to list contents of a library.

CLI EXAMPLES

•   List all document files associated will all entries:

    papis list --file

•   List all document year and title with custom formatting:

    papis list --format '{doc[year]} {doc[title]}'

•   List all documents according to the bibitem formatting (stored in a template file bibitem.template):

    papis list --template bibitem.template

PYTHON EXAMPLES

# Import the run function from the list command
from papis.commands.list import run as papis_list
documents = papis_list(query='einstein', library='papis')
for doc in documents:
    print(doc["url"])
# etc...
info_files = list(query='einstein', library='papis', info_files=True)
# do something with the info file paths...

CLI

  papis list

List documents' properties

papis list [OPTIONS] [QUERY]
Options.INDENT 0.0

-h, --help
    Show this message and exit.

-i, --info
    Show the info file name associated with the document

-f, --file
    Show the file name associated with the document

-d, --dir
    Show the folder name associated with the document

--format <format>
    List entries using a custom papis format, e.g. '{doc[year] {doc[title]}

--template <template>
    Template file containing a papis format to list entries

-p, --pick
    Pick the document instead of listing everything

--downloaders
    List available downloaders

--libraries
    List defined libraries Arguments.INDENT 0.0

QUERY
    Optional argument

AUTHOR
Alejandro Gallo

COPYRIGHT
2017, Alejandro Gallo