Skip to content

Commit

Permalink
v1.4.1 update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@ferru97
ferru97 committed Dec 8, 2024
1 parent 2a965dc commit 71b4047
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,27 +52,28 @@ pip install PyPaperbot

PyPaperBot arguments:

| Arguments | Description | Type |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|
| \-\-query | Query to make on Google Scholar or Google Scholar page link | string |
| \-\-cites | Paper ID (from scholar address bar when you search cites) if you want get only citations of that paper | string | string |
| \-\-doi | DOI of the paper to download (this option uses only SciHub to download) | string |
| \-\-doi-file | File .txt containing the list of paper's DOIs to download | string |
| \-\-scholar-pages | Number or range of Google Scholar pages to inspect. Each page has a maximum of 10 papers | string |
| \-\-dwn-dir | Directory path in which to save the result | string |
| \-\-min-year | Minimal publication year of the paper to download | int |
| \-\-max-dwn-year | Maximum number of papers to download sorted by year | int |
| \-\-max-dwn-cites | Maximum number of papers to download sorted by number of citations | int |
| \-\-journal-filter | CSV file path of the journal filter (More info on github) | string |
| \-\-restrict | 0:Download only Bibtex - 1:Download only papers PDF | int |
| \-\-scihub-mirror | Mirror for downloading papers from sci-hub. If not set, it is selected automatically | string |
| \-\-annas-archive-mirror | Mirror for downloading papers from Annas Archive (SciDB). If not set, https://annas-archive.se is used | string |
| \-\-scholar-results | Number of scholar results to bedownloaded when \-\-scholar-pages=1 | int |
| \-\-proxy | Proxies to be used. Please specify the protocol to be used. | string |
| \-\-single-proxy | Use a single proxy. Recommended if using --proxy gives errors. | string |
| Arguments | Description | Type |
|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|
| \-\-query | Query to make on Google Scholar or Google Scholar page link | string |
| \-\-skip-words | List of comma separated words i.e. "word1,word2 word3,word4". Articles containing any of this word in the title or google scholar summary will be ignored | string |
| \-\-cites | Paper ID (from scholar address bar when you search cites) if you want get only citations of that paper | string | string |
| \-\-doi | DOI of the paper to download (this option uses only SciHub to download) | string |
| \-\-doi-file | File .txt containing the list of paper's DOIs to download | string |
| \-\-scholar-pages | Number or range of Google Scholar pages to inspect. Each page has a maximum of 10 papers | string |
| \-\-dwn-dir | Directory path in which to save the result | string |
| \-\-min-year | Minimal publication year of the paper to download | int |
| \-\-max-dwn-year | Maximum number of papers to download sorted by year | int |
| \-\-max-dwn-cites | Maximum number of papers to download sorted by number of citations | int |
| \-\-journal-filter | CSV file path of the journal filter (More info on github) | string |
| \-\-restrict | 0:Download only Bibtex - 1:Download only papers PDF | int |
| \-\-scihub-mirror | Mirror for downloading papers from sci-hub. If not set, it is selected automatically | string |
| \-\-annas-archive-mirror | Mirror for downloading papers from Annas Archive (SciDB). If not set, https://annas-archive.se is used | string |
| \-\-scholar-results | Number of scholar results to bedownloaded when \-\-scholar-pages=1 | int |
| \-\-proxy | Proxies to be used. Please specify the protocol to be used. | string |
| \-\-single-proxy | Use a single proxy. Recommended if using --proxy gives errors. | string |
| \-\-selenium-chrome-version | First three digits of the chrome version installed on your machine. If provided, selenium will be used for scholar search. It helps avoid bot detection but chrome must be installed. | int |
| \-\-use-doi-as-filename | If provided, files are saved using the unique DOI as the filename rather than the default paper title | bool |
| \-h | Shows the help | -- |
| \-\-use-doi-as-filename | If provided, files are saved using the unique DOI as the filename rather than the default paper title | bool |
| \-h | Shows the help | -- |

### Note

Expand Down Expand Up @@ -104,10 +105,10 @@ Download a maximum of 30 papers from the first 3 pages given a query and startin
python -m PyPaperBot --query="Machine learning" --scholar-pages=3 --min-year=2018 --dwn-dir="C:\User\example\papers" --scihub-mirror="https://sci-hub.do"
```

Download papers from pages 4 to 7 (7th included) given a query:
Download papers from pages 4 to 7 (7th included) given a query and skip words:

```bash
python -m PyPaperBot --query="Machine learning" --scholar-pages=4-7 --dwn-dir="C:\User\example\papers"
python -m PyPaperBot --query="Machine learning" --scholar-pages=4-7 --dwn-dir="C:\User\example\papers" --skip-words="ai,decision tree,bot"
```

Download a paper given the DOI:
Expand Down

0 comments on commit 71b4047

Please sign in to comment.