Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
devmessias committed Aug 27, 2017
1 parent 53ac2dc commit 4c4a1e1
Show file tree
Hide file tree
Showing 2 changed files with 224 additions and 39 deletions.
136 changes: 114 additions & 22 deletions README
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
Description
-----------
===========

doi2bib is a module of `bibcure <https://github.com/bibcure/bibcure>`__
## Install
doi2bib is a module of
`bibcure <https://github.com/bibcure/bibcure>`__\ and
`scihub2pdf <https://github.com/bibcure/scihub2pdf>`__

Install
=======

::

Expand All @@ -15,46 +19,134 @@ or if you want the full version
$ sudo pip install bibcure

Features and how to use
-----------------------
=======================

Given a DOI number...

::

$ bibcure -i input.bib -o output.bib
$ doi2bib 10.1038/s41524-017-0032-0

Given a bib file... \* check sure the Arxiv items have been published,
then update them(requires internet connection) \* complete all
fields(url, journal, etc) of all bib items using DOI number(requires
internet connection) \* find and create DOI number associated with each
bib item which has not DOI field(requires internet connection) \*
abbreviate jorunals names
- get bib item given a doi(requires internet connection)

You can easily append a bib into a bibfile, just do

::

$ doi2bib 10.1038/s41524-017-0032-0
$ doi2bib 10.1038/s41524-017-0032-0 >> file.bib

You also can generate a bibtex from a txt file containing a list of DOIs

::

$ doi2bib --input file_with_dois.txt --output refs.bib

bibcure
-------

Given a bib file...

::

$ bibcure -i input.bib -o output.bib

- check sure the Arxiv items have been published, then update
them(requires internet connection)

- complete all fields(url, journal, etc) of all bib items using DOI
number(requires internet connection)

- find and create DOI number associated with each bib item which has
not DOI field(requires internet connection)

Given a DOI number... \* get bib item given a doi(requires internet
connection)
- abbreviate jorunals names

title2bib
---------

Given a title...

::

$ title2bib An useful paper

Given a title... \* search papers related and return a bib for the
selected paper(requires internet connection)
- search papers related and return a bib for the selected
paper(requires internet connection)

You can easily append a bib into a bibfile, just do

::

$ title2bib An useful paper --first >> file.bib

You also can generate a bibtex from a txt file containing a list of
"titles"

::

$ title2bib --input file_with_titles.txt --output refs.bib --first

arxivcheck
----------

Given a arxiv id...

::

$ arxivcheck 1601.02785

Given a arxiv id... \* given an arixiv id, check if has been published,
and then returns the updated bib (requires internet connection)
- check if has been published, and then returns the updated bib
(requires internet connection)

Next Version
~~~~~~~~~~~~
Given a title...

::

$ bibcure -i input.bib -o output.bib
$ arxivcheck --title An useful paper published on arxiv

search papers related and return a bib the first item. You can easily
append a bib into a bibfile, just do

::

$ arxivcheck --title An useful paper published on arxiv >> file.bib

You also can interact with results, just pass --ask parameter

::

$ arxivcheck --ask --title An useful paper published on arxiv

scihub2pdf
==========

Given a bibtex file

::

$ scihub2pdf -i input.bib

Given a DOI number...

::

$ scihub2pdf 10.1038/s41524-017-0032-0

Given a title...

::

$ scihub2bib --title An useful paper

Location folder as argument

::

$ scihub2pdf -i input.bib -l somefoler/

Use libgen instead sci-hub

::

- contract authors names
$ scihub2pdf -i input.bib --uselibgen

127 changes: 110 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Description
doi2bib is a module of [bibcure](https://github.com/bibcure/bibcure)
## Install
# Description
doi2bib is a module of [bibcure](https://github.com/bibcure/bibcure)and [scihub2pdf](https://github.com/bibcure/scihub2pdf)

# Install

```
$ sudo pip install doi2bib
Expand All @@ -10,41 +11,133 @@ or if you want the full version
```
$ sudo pip install bibcure
```
## Features and how to use
# Features and how to use


Given a DOI number...

```
$ bibcure -i input.bib -o output.bib
$ doi2bib 10.1038/s41524-017-0032-0
```

* get bib item given a doi(requires
internet connection)

You can easily append
a bib into a bibfile, just do

```
$ doi2bib 10.1038/s41524-017-0032-0 >> file.bib
```

You also can generate a bibtex from a txt file containing a list of DOIs

```
$ doi2bib --input file_with_dois.txt --output refs.bib
```

## bibcure

Given a bib file...

```
$ bibcure -i input.bib -o output.bib
```

* check sure the Arxiv items have been published, then update them(requires
internet connection)

* complete all fields(url, journal, etc) of all bib items using DOI number(requires
internet connection)

* find and create DOI number associated with each bib item which has not
DOI field(requires
internet connection)

* abbreviate jorunals names
```
$ doi2bib 10.1038/s41524-017-0032-0
```
Given a DOI number...
* get bib item given a doi(requires
internet connection)


## title2bib

Given a title...

```
$ title2bib An useful paper
```
Given a title...

* search papers related and return a bib for the selected paper(requires
internet connection)

You can easily append
a bib into a bibfile, just do

```
$ arxivcheck 1601.02785
$ title2bib An useful paper --first >> file.bib
```

You also can generate a bibtex from a txt file containing a list of "titles"

```
$ title2bib --input file_with_titles.txt --output refs.bib --first
```

## arxivcheck

Given a arxiv id...
* given an arixiv id, check if has been published, and then returns the updated bib (requires internet connection)

### Next Version
```
$ bibcure -i input.bib -o output.bib
$ arxivcheck 1601.02785
```

* check if has been published, and then returns the updated bib (requires internet connection)

Given a title...

```
$ arxivcheck --title An useful paper published on arxiv
```

search papers related and return a bib the first item.
You can easily append a bib into a bibfile, just do

```
$ arxivcheck --title An useful paper published on arxiv >> file.bib
```

You also can interact with results, just pass --ask parameter

```
$ arxivcheck --ask --title An useful paper published on arxiv
```

# scihub2pdf

Given a bibtex file

```
$ scihub2pdf -i input.bib
```

Given a DOI number...

```
$ scihub2pdf 10.1038/s41524-017-0032-0
```

Given a title...

```
$ scihub2bib --title An useful paper
```

Location folder as argument

```
$ scihub2pdf -i input.bib -l somefoler/
```

Use libgen instead sci-hub

```
$ scihub2pdf -i input.bib --uselibgen
```
* contract authors names

0 comments on commit 4c4a1e1

Please sign in to comment.