pmcfetch 0.2.0__tar.gz → 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. {pmcfetch-0.2.0/src/pmcfetch.egg-info → pmcfetch-0.2.1}/PKG-INFO +30 -8
  2. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/README.md +29 -7
  3. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/__init__.py +1 -1
  4. {pmcfetch-0.2.0 → pmcfetch-0.2.1/src/pmcfetch.egg-info}/PKG-INFO +30 -8
  5. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/LICENSE +0 -0
  6. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/MANIFEST.in +0 -0
  7. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/pyproject.toml +0 -0
  8. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/setup.cfg +0 -0
  9. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/batch.py +0 -0
  10. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/cli.py +0 -0
  11. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/errors.py +0 -0
  12. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/ids.py +0 -0
  13. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/manifest.py +0 -0
  14. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/pdf.py +0 -0
  15. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/py.typed +0 -0
  16. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/ratelimit.py +0 -0
  17. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/s3source.py +0 -0
  18. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch/search.py +0 -0
  19. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch.egg-info/SOURCES.txt +0 -0
  20. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch.egg-info/dependency_links.txt +0 -0
  21. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch.egg-info/entry_points.txt +0 -0
  22. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch.egg-info/requires.txt +0 -0
  23. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/src/pmcfetch.egg-info/top_level.txt +0 -0
  24. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/conftest.py +0 -0
  25. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/test_batch.py +0 -0
  26. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/test_cli.py +0 -0
  27. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/test_ids.py +0 -0
  28. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/test_manifest.py +0 -0
  29. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/test_s3source.py +0 -0
  30. {pmcfetch-0.2.0 → pmcfetch-0.2.1}/tests/test_search.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pmcfetch
3
- Version: 0.2.0
3
+ Version: 0.2.1
4
4
  Summary: Search the PMC Open Access Subset by keyword and download article PDFs from AWS. Zero dependencies.
5
5
  Author: Kavach Shah
6
6
  License-Expression: MIT
@@ -32,18 +32,40 @@ Dynamic: license-file
32
32
 
33
33
  # pmcfetch
34
34
 
35
- Targeted PDF retrieval from the **PMC Open Access Subset**, with resume, retries,
36
- atomic writes, and namespace-aware batch layout. Start from a list of PMC ids,
37
- or from a keyword search. Zero dependencies.
35
+ Download open-access research papers as PDFs from **PubMed Central**, straight
36
+ from the PMC Open Access Subset on AWS, with resume, retries and atomic writes.
37
+ Requires Python 3.10+, and nothing outside the standard library.
38
38
 
39
39
  ```bash
40
40
  pip install pmcfetch
41
- pmcfetch search "burn scar" # how many open-access papers match?
42
- pmcfetch search "burn scar" --download 50 # fetch the 50 most relevant
43
- pmcfetch download --corpus corpus.json --out pdfs/ --workers 16
44
41
  ```
45
42
 
46
- Requires Python 3.10+. Nothing outside the standard library.
43
+ ## What it does
44
+
45
+ **1. Download papers by id.** You already know which papers you want: list their
46
+ PMC ids in a text file, one per line (like `PMC10007932`).
47
+
48
+ ```bash
49
+ pmcfetch download --corpus ids.txt --out pdfs/
50
+ ```
51
+
52
+ **2. Search by keyword.** See how many open-access papers match before
53
+ downloading anything.
54
+
55
+ ```bash
56
+ pmcfetch search "burn scar"
57
+ # [pmcfetch] 20,349 open-access article(s) match 'burn scar'
58
+ ```
59
+
60
+ **3. Download the matches.** Take all of them, or only as many as you want.
61
+
62
+ ```bash
63
+ pmcfetch search "burn scar" --download 50 # the 50 most relevant
64
+ pmcfetch search "burn scar" --download all # every match
65
+ ```
66
+
67
+ In a terminal, `pmcfetch search` asks how many to download right after showing
68
+ the count, so steps 2 and 3 can happen in one go.
47
69
 
48
70
  ## Why
49
71
 
@@ -1,17 +1,39 @@
1
1
  # pmcfetch
2
2
 
3
- Targeted PDF retrieval from the **PMC Open Access Subset**, with resume, retries,
4
- atomic writes, and namespace-aware batch layout. Start from a list of PMC ids,
5
- or from a keyword search. Zero dependencies.
3
+ Download open-access research papers as PDFs from **PubMed Central**, straight
4
+ from the PMC Open Access Subset on AWS, with resume, retries and atomic writes.
5
+ Requires Python 3.10+, and nothing outside the standard library.
6
6
 
7
7
  ```bash
8
8
  pip install pmcfetch
9
- pmcfetch search "burn scar" # how many open-access papers match?
10
- pmcfetch search "burn scar" --download 50 # fetch the 50 most relevant
11
- pmcfetch download --corpus corpus.json --out pdfs/ --workers 16
12
9
  ```
13
10
 
14
- Requires Python 3.10+. Nothing outside the standard library.
11
+ ## What it does
12
+
13
+ **1. Download papers by id.** You already know which papers you want: list their
14
+ PMC ids in a text file, one per line (like `PMC10007932`).
15
+
16
+ ```bash
17
+ pmcfetch download --corpus ids.txt --out pdfs/
18
+ ```
19
+
20
+ **2. Search by keyword.** See how many open-access papers match before
21
+ downloading anything.
22
+
23
+ ```bash
24
+ pmcfetch search "burn scar"
25
+ # [pmcfetch] 20,349 open-access article(s) match 'burn scar'
26
+ ```
27
+
28
+ **3. Download the matches.** Take all of them, or only as many as you want.
29
+
30
+ ```bash
31
+ pmcfetch search "burn scar" --download 50 # the 50 most relevant
32
+ pmcfetch search "burn scar" --download all # every match
33
+ ```
34
+
35
+ In a terminal, `pmcfetch search` asks how many to download right after showing
36
+ the count, so steps 2 and 3 can happen in one go.
15
37
 
16
38
  ## Why
17
39
 
@@ -24,7 +24,7 @@ Zero third-party dependencies.
24
24
 
25
25
  from __future__ import annotations
26
26
 
27
- __version__ = "0.2.0"
27
+ __version__ = "0.2.1"
28
28
 
29
29
  from pmcfetch.batch import (
30
30
  BatchReport,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pmcfetch
3
- Version: 0.2.0
3
+ Version: 0.2.1
4
4
  Summary: Search the PMC Open Access Subset by keyword and download article PDFs from AWS. Zero dependencies.
5
5
  Author: Kavach Shah
6
6
  License-Expression: MIT
@@ -32,18 +32,40 @@ Dynamic: license-file
32
32
 
33
33
  # pmcfetch
34
34
 
35
- Targeted PDF retrieval from the **PMC Open Access Subset**, with resume, retries,
36
- atomic writes, and namespace-aware batch layout. Start from a list of PMC ids,
37
- or from a keyword search. Zero dependencies.
35
+ Download open-access research papers as PDFs from **PubMed Central**, straight
36
+ from the PMC Open Access Subset on AWS, with resume, retries and atomic writes.
37
+ Requires Python 3.10+, and nothing outside the standard library.
38
38
 
39
39
  ```bash
40
40
  pip install pmcfetch
41
- pmcfetch search "burn scar" # how many open-access papers match?
42
- pmcfetch search "burn scar" --download 50 # fetch the 50 most relevant
43
- pmcfetch download --corpus corpus.json --out pdfs/ --workers 16
44
41
  ```
45
42
 
46
- Requires Python 3.10+. Nothing outside the standard library.
43
+ ## What it does
44
+
45
+ **1. Download papers by id.** You already know which papers you want: list their
46
+ PMC ids in a text file, one per line (like `PMC10007932`).
47
+
48
+ ```bash
49
+ pmcfetch download --corpus ids.txt --out pdfs/
50
+ ```
51
+
52
+ **2. Search by keyword.** See how many open-access papers match before
53
+ downloading anything.
54
+
55
+ ```bash
56
+ pmcfetch search "burn scar"
57
+ # [pmcfetch] 20,349 open-access article(s) match 'burn scar'
58
+ ```
59
+
60
+ **3. Download the matches.** Take all of them, or only as many as you want.
61
+
62
+ ```bash
63
+ pmcfetch search "burn scar" --download 50 # the 50 most relevant
64
+ pmcfetch search "burn scar" --download all # every match
65
+ ```
66
+
67
+ In a terminal, `pmcfetch search` asks how many to download right after showing
68
+ the count, so steps 2 and 3 can happen in one go.
47
69
 
48
70
  ## Why
49
71
 
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes