summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Gallo <aamsgallo@gmail.com>2017-10-15 12:21:49 +0200
committerAlejandro Gallo <aamsgallo@gmail.com>2017-10-15 12:21:49 +0200
commit73a743f09617fb0debf7ab292290bed3d3c7d65d (patch)
tree7c4bb27a49a270f72845d8fbd98822833dd3f74e
parent761ac6a089c44b7519bbb0aa09eb03fea22de00f (diff)
Update versionv0.4.1
-rw-r--r--doc/build/man/papis-config.1246
-rw-r--r--doc/build/man/papis.1355
-rw-r--r--papis/__init__.py2
3 files changed, 355 insertions, 248 deletions
diff --git a/doc/build/man/papis-config.1 b/doc/build/man/papis-config.1
index ced21661..dca33a2c 100644
--- a/doc/build/man/papis-config.1
+++ b/doc/build/man/papis-config.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "PAPIS-CONFIG" "1" "Oct 10, 2017" "0.4" "papis"
+.TH "PAPIS-CONFIG" "1" "Oct 15, 2017" "0.4.1" "papis"
.SH NAME
papis-config \- Papis Configuration
.
@@ -157,7 +157,7 @@ Default: \fB{doc[title]} {doc[author]}\fP
Default: \fBxdg\-open\fP
.TP
.B cache\-dir
-Default: \fB/home/ale/.cache/papis\fP
+Default: \fB/home/gallo/.cache/papis\fP
.TP
.B check\-keys
Default: \fBfiles\fP
@@ -252,127 +252,6 @@ Default: \fBMozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (K
.B xeditor
Default: \fBxdg\-open\fP
.UNINDENT
-.SS vim\-gui
-.INDENT 0.0
-.TP
-.B delete\-key
-Default: \fBdd\fP
-.TP
-.B edit\-key
-Default: \fBe\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-Title : {doc[title]}
-Author: {doc[author]}
-Year : {doc[year]}
-\-\-\-\-\-\-\-
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B help\-key
-Default: \fBh\fP
-.TP
-.B next\-search\-key
-Default: \fBn\fP
-.TP
-.B open\-dir\-key
-Default: \fB<S\-o>\fP
-.TP
-.B open\-key
-Default: \fBo\fP
-.TP
-.B prev\-search\-key
-Default: \fBN\fP
-.TP
-.B search\-key
-Default: \fB/\fP
-.UNINDENT
-.SS rofi\-gui
-.INDENT 0.0
-.TP
-.B case_sensitive
-Default: \fBFalse\fP
-.TP
-.B eh
-Default: \fB3\fP
-.TP
-.B fixed_lines
-Default: \fB20\fP
-.TP
-.B fullscreen
-Default: \fBFalse\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-<b>{doc[title]}</b>
-{doc[empty]} <i>{doc[author]}</i>
-{doc[empty]} <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B key\-browse
-Default: \fBAlt+u\fP
-.TP
-.B key\-delete
-Default: \fBAlt+d\fP
-.TP
-.B key\-edit
-Default: \fBAlt+e\fP
-.TP
-.B key\-help
-Default: \fBAlt+h\fP
-.TP
-.B key\-normal\-window
-Default: \fBAlt+w\fP
-.TP
-.B key\-open
-Default: \fBEnter\fP
-.TP
-.B key\-open\-stay
-Default: \fBAlt+o\fP
-.TP
-.B key\-quit
-Default: \fBAlt+q\fP
-.TP
-.B lines
-Default: \fB10\fP
-.TP
-.B markup_rows
-Default: \fBTrue\fP
-.TP
-.B multi_select
-Default: \fBTrue\fP
-.TP
-.B normal_window
-Default: \fBFalse\fP
-.TP
-.B sep
-Default: \fB|\fP
-.TP
-.B width
-Default: \fB80\fP
-.UNINDENT
.SS tk\-gui
.INDENT 0.0
.TP
@@ -505,6 +384,127 @@ Default: \fB700\fP
.B window\-width
Default: \fB1200\fP
.UNINDENT
+.SS vim\-gui
+.INDENT 0.0
+.TP
+.B delete\-key
+Default: \fBdd\fP
+.TP
+.B edit\-key
+Default: \fBe\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+Title : {doc[title]}
+Author: {doc[author]}
+Year : {doc[year]}
+\-\-\-\-\-\-\-
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B help\-key
+Default: \fBh\fP
+.TP
+.B next\-search\-key
+Default: \fBn\fP
+.TP
+.B open\-dir\-key
+Default: \fB<S\-o>\fP
+.TP
+.B open\-key
+Default: \fBo\fP
+.TP
+.B prev\-search\-key
+Default: \fBN\fP
+.TP
+.B search\-key
+Default: \fB/\fP
+.UNINDENT
+.SS rofi\-gui
+.INDENT 0.0
+.TP
+.B case_sensitive
+Default: \fBFalse\fP
+.TP
+.B eh
+Default: \fB3\fP
+.TP
+.B fixed_lines
+Default: \fB20\fP
+.TP
+.B fullscreen
+Default: \fBFalse\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<b>{doc[title]}</b>
+{doc[empty]} <i>{doc[author]}</i>
+{doc[empty]} <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B key\-browse
+Default: \fBAlt+u\fP
+.TP
+.B key\-delete
+Default: \fBAlt+d\fP
+.TP
+.B key\-edit
+Default: \fBAlt+e\fP
+.TP
+.B key\-help
+Default: \fBAlt+h\fP
+.TP
+.B key\-normal\-window
+Default: \fBAlt+w\fP
+.TP
+.B key\-open
+Default: \fBEnter\fP
+.TP
+.B key\-open\-stay
+Default: \fBAlt+o\fP
+.TP
+.B key\-quit
+Default: \fBAlt+q\fP
+.TP
+.B lines
+Default: \fB10\fP
+.TP
+.B markup_rows
+Default: \fBTrue\fP
+.TP
+.B multi_select
+Default: \fBTrue\fP
+.TP
+.B normal_window
+Default: \fBFalse\fP
+.TP
+.B sep
+Default: \fB|\fP
+.TP
+.B width
+Default: \fB80\fP
+.UNINDENT
.SH AUTHOR
Alejandro Gallo
.SH COPYRIGHT
diff --git a/doc/build/man/papis.1 b/doc/build/man/papis.1
index 47198205..1cdd9329 100644
--- a/doc/build/man/papis.1
+++ b/doc/build/man/papis.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "PAPIS" "1" "Oct 10, 2017" "0.4" "papis"
+.TH "PAPIS" "1" "Oct 15, 2017" "0.4.1" "papis"
.SH NAME
papis \- Papis Documentation
.
@@ -503,7 +503,7 @@ Default: \fB{doc[title]} {doc[author]}\fP
Default: \fBxdg\-open\fP
.TP
.B cache\-dir
-Default: \fB/home/ale/.cache/papis\fP
+Default: \fB/home/gallo/.cache/papis\fP
.TP
.B check\-keys
Default: \fBfiles\fP
@@ -598,127 +598,6 @@ Default: \fBMozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (K
.B xeditor
Default: \fBxdg\-open\fP
.UNINDENT
-.SS vim\-gui
-.INDENT 0.0
-.TP
-.B delete\-key
-Default: \fBdd\fP
-.TP
-.B edit\-key
-Default: \fBe\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-Title : {doc[title]}
-Author: {doc[author]}
-Year : {doc[year]}
-\-\-\-\-\-\-\-
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B help\-key
-Default: \fBh\fP
-.TP
-.B next\-search\-key
-Default: \fBn\fP
-.TP
-.B open\-dir\-key
-Default: \fB<S\-o>\fP
-.TP
-.B open\-key
-Default: \fBo\fP
-.TP
-.B prev\-search\-key
-Default: \fBN\fP
-.TP
-.B search\-key
-Default: \fB/\fP
-.UNINDENT
-.SS rofi\-gui
-.INDENT 0.0
-.TP
-.B case_sensitive
-Default: \fBFalse\fP
-.TP
-.B eh
-Default: \fB3\fP
-.TP
-.B fixed_lines
-Default: \fB20\fP
-.TP
-.B fullscreen
-Default: \fBFalse\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-<b>{doc[title]}</b>
-{doc[empty]} <i>{doc[author]}</i>
-{doc[empty]} <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B key\-browse
-Default: \fBAlt+u\fP
-.TP
-.B key\-delete
-Default: \fBAlt+d\fP
-.TP
-.B key\-edit
-Default: \fBAlt+e\fP
-.TP
-.B key\-help
-Default: \fBAlt+h\fP
-.TP
-.B key\-normal\-window
-Default: \fBAlt+w\fP
-.TP
-.B key\-open
-Default: \fBEnter\fP
-.TP
-.B key\-open\-stay
-Default: \fBAlt+o\fP
-.TP
-.B key\-quit
-Default: \fBAlt+q\fP
-.TP
-.B lines
-Default: \fB10\fP
-.TP
-.B markup_rows
-Default: \fBTrue\fP
-.TP
-.B multi_select
-Default: \fBTrue\fP
-.TP
-.B normal_window
-Default: \fBFalse\fP
-.TP
-.B sep
-Default: \fB|\fP
-.TP
-.B width
-Default: \fB80\fP
-.UNINDENT
.SS tk\-gui
.INDENT 0.0
.TP
@@ -851,6 +730,127 @@ Default: \fB700\fP
.B window\-width
Default: \fB1200\fP
.UNINDENT
+.SS vim\-gui
+.INDENT 0.0
+.TP
+.B delete\-key
+Default: \fBdd\fP
+.TP
+.B edit\-key
+Default: \fBe\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+Title : {doc[title]}
+Author: {doc[author]}
+Year : {doc[year]}
+\-\-\-\-\-\-\-
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B help\-key
+Default: \fBh\fP
+.TP
+.B next\-search\-key
+Default: \fBn\fP
+.TP
+.B open\-dir\-key
+Default: \fB<S\-o>\fP
+.TP
+.B open\-key
+Default: \fBo\fP
+.TP
+.B prev\-search\-key
+Default: \fBN\fP
+.TP
+.B search\-key
+Default: \fB/\fP
+.UNINDENT
+.SS rofi\-gui
+.INDENT 0.0
+.TP
+.B case_sensitive
+Default: \fBFalse\fP
+.TP
+.B eh
+Default: \fB3\fP
+.TP
+.B fixed_lines
+Default: \fB20\fP
+.TP
+.B fullscreen
+Default: \fBFalse\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<b>{doc[title]}</b>
+{doc[empty]} <i>{doc[author]}</i>
+{doc[empty]} <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B key\-browse
+Default: \fBAlt+u\fP
+.TP
+.B key\-delete
+Default: \fBAlt+d\fP
+.TP
+.B key\-edit
+Default: \fBAlt+e\fP
+.TP
+.B key\-help
+Default: \fBAlt+h\fP
+.TP
+.B key\-normal\-window
+Default: \fBAlt+w\fP
+.TP
+.B key\-open
+Default: \fBEnter\fP
+.TP
+.B key\-open\-stay
+Default: \fBAlt+o\fP
+.TP
+.B key\-quit
+Default: \fBAlt+q\fP
+.TP
+.B lines
+Default: \fB10\fP
+.TP
+.B markup_rows
+Default: \fBTrue\fP
+.TP
+.B multi_select
+Default: \fBTrue\fP
+.TP
+.B normal_window
+Default: \fBFalse\fP
+.TP
+.B sep
+Default: \fB|\fP
+.TP
+.B width
+Default: \fB80\fP
+.UNINDENT
.SH THE INFO.YAML FILE
.sp
At the heart of papis there is the information file. The info file contains
@@ -1320,7 +1320,8 @@ Default: False
.sp
.nf
.ft C
-usage: papis explore [\-h] [\-\-arxiv] [\-\-max MAX] [search [search ...]]
+usage: papis explore [\-h] [\-\-isbnplus] [\-\-arxiv] [\-\-libgen] [\-\-max MAX]
+ [search [search ...]]
.ft P
.fi
.UNINDENT
@@ -1336,11 +1337,21 @@ Default: []
.SS Named Arguments
.INDENT 0.0
.TP
+.B\-\-isbnplus
+Search through isbnplus.org
+.sp
+Default: False
+.TP
.B\-\-arxiv
Search on the arxiv
.sp
Default: False
.TP
+.B\-\-libgen
+Search on library genesis
+.sp
+Default: False
+.TP
.B\-\-max
Maximum number of items
.sp
@@ -2100,6 +2111,102 @@ args passed by the user.
.SH GIT
.sp
Papis is conceived to work well with the tool \fIgit\fP\&.
+.SH SCIHUB SUPPORT
+.sp
+Papis has a script that uses the scihub platform to download scientific
+papers. Due to legal caution the script is not included directly
+as a papis command, and it is written \fBbash\fP\&.
+.sp
+If you want to use it, you can download it from
+\fI\%here\fP
+and copy it into your papis script folder.
+.sp
+Usuar locations for your script folder are
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+\fB~/.config/papis/scripts\fP
+.IP \(bu 2
+\fB~/.papis/scripts\fP
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Therefore, if you decide to have the script folder in the first option,
+you can install the script by doing:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+wget \-O ~/.config/papis/scripts/papis\-scihub https://raw.githubusercontent.com/alejandrogallo/papis/master/examples/scripts/papis\-scihub
+chmod +x ~/.config/papis/scripts/papis\-scihub
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fBchmod +x\fP command is necessary to make the \fBpapis\-scihub\fP file
+executable.
+.sp
+Now you can type
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis scihub \-h
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+and see the help message of the script.
+.sp
+Some usage examples are:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+Download via the doi number:
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis scihub 10\&.1002/andp.19053220607 \-d einstein_papers \-\-name photon_definition
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.IP \(bu 2
+Download via a url that contains the doi number in the format \fB\&.*/doi/<doinumber>\fP
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis scihub http://physicstoday.scitation.org/doi/10.1063/1.881498 \-\-name important_paper
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.IP \(bu 2
+Download via the \fBdoi.org\fP url:
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis scihub https://doi.org/10.1016/j.physrep.2016.12.002
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
.SH FAQ
.sp
Here are some problems that users have come accross with often:
diff --git a/papis/__init__.py b/papis/__init__.py
index 0d3b0767..85004ad9 100644
--- a/papis/__init__.py
+++ b/papis/__init__.py
@@ -1,7 +1,7 @@
# Information
__license__ = 'GPL3'
-__version__ = '0.4'
+__version__ = '0.4.1'
__author__ = __maintainer__ = 'Alejandro Gallo'
__email__ = 'aamsgallo@gmail.com'