lixplore-cli 1.2.1__tar.gz → 1.2.3__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.
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/CHANGELOG.md +24 -1
- {lixplore_cli-1.2.1/lixplore_cli.egg-info → lixplore_cli-1.2.3}/PKG-INFO +44 -39
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/README.md +39 -33
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/README.md +1 -1
- lixplore_cli-1.2.3/docs/about/changelog.md +3 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/about/faq.md +3 -3
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/examples/automation-examples.md +2 -2
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/examples/integrations.md +1 -1
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/getting-started/installation.md +2 -2
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/getting-started/quickstart.md +1 -1
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/interactive.md +1 -1
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/search-sources.md +26 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/index.md +2 -2
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/flags-overview.md +1 -1
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/config.py +8 -3
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/runner.py +9 -3
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/sources/pubmed.py +58 -15
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3/lixplore_cli.egg-info}/PKG-INFO +44 -39
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore_cli.egg-info/requires.txt +0 -4
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/pyproject.toml +5 -6
- lixplore_cli-1.2.1/docs/about/changelog.md +0 -93
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/LICENSE +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/MANIFEST.in +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/about/contributing.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/about/license.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/advanced/ai-integration.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/advanced/automation.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/advanced/custom-apis.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/advanced/profiles.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/advanced/zotero.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/examples/use-cases.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/examples/workflows.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/getting-started/basic-usage.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/getting-started/first-search.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/alerts.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/annotations.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/export.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/filtering.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/pdf.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/guide/search.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/lixplore.1 +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/lixplore.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/annotation-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/display-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/export-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/filter-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/interactive-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/search-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/source-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/docs/reference/utility-flags.md +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/__init__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/__main__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/__init__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/__main__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/env.example +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/gate.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/notify.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/render.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/alerts/state.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/cli.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/commands.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/dispatcher.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/search.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/sources/__init__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/sources/arxiv.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/sources/crossref.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/sources/doaj.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/sources/europepmc.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/templates/__init__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/templates/ieee.json +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/templates/nature.json +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/templates/science.json +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/tui/__init__.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/tui/app.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/tui/modals.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/annotations.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/cache.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/citations.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/custom_apis.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/enhanced_tui.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/enrichment.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/export.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/interactive_tui.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/pdf_downloader.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/profiles.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/reference_managers.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/rich_check.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/shell_mode.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/statistics.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/template_engine.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/terminal.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore/utils/wizard_mode.py +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore_cli.egg-info/SOURCES.txt +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore_cli.egg-info/dependency_links.txt +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore_cli.egg-info/entry_points.txt +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/lixplore_cli.egg-info/top_level.txt +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/requirements.txt +0 -0
- {lixplore_cli-1.2.1 → lixplore_cli-1.2.3}/setup.cfg +0 -0
|
@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [1.2.3] - 2026-09-27
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
- PubMed email and API key can be set in `~/.lixplore/config.json`, which also works for pip,
|
|
14
|
+
AUR and Homebrew installs (before, only `PUBMED_EMAIL` / `PUBMED_API_KEY` did)
|
|
15
|
+
|
|
16
|
+
## [1.2.2] - 2026-09-27
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
- Python 3.9 or newer is required (3.8 reached end of life in October 2024; source builds on it
|
|
20
|
+
already failed). CI now tests 3.9 to 3.13
|
|
21
|
+
|
|
22
|
+
### Fixed
|
|
23
|
+
- Alerts `.env`: when a variable appears twice, the later line now wins (as in other `.env` tools).
|
|
24
|
+
Before, a `LIXPLORE_QUERIES` line added below the `init` template's example was silently ignored
|
|
25
|
+
- Alerts `test` and `check` work before any search is set, so channels can be tested first
|
|
26
|
+
(before, both stopped with "LIXPLORE_QUERIES is empty"). `run` and `dry-run` still require it
|
|
27
|
+
- PubMed: DOIs were missing for many older papers (the DOI was read only from `ELocationID`,
|
|
28
|
+
not from the article ID list), which weakened deduplication, enrichment and PDF lookup
|
|
29
|
+
- PubMed: year was empty when the record only has a date range such as "2001 May 1-15"
|
|
30
|
+
- PubMed: when NCBI's search backend is temporarily down, requests are retried and a clear
|
|
31
|
+
"temporarily unavailable" message is shown instead of the raw server error
|
|
32
|
+
|
|
10
33
|
## [1.2.1] - 2026-09-27
|
|
11
34
|
|
|
12
35
|
### Fixed
|
|
@@ -206,4 +229,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
206
229
|
|
|
207
230
|
---
|
|
208
231
|
|
|
209
|
-
For more details, see the [README](
|
|
232
|
+
For more details, see the [README](https://github.com/pryndor/Lixplore_cli#readme).
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: lixplore-cli
|
|
3
|
-
Version: 1.2.
|
|
4
|
-
Summary:
|
|
3
|
+
Version: 1.2.3
|
|
4
|
+
Summary: Unix-inspired CLI for searching PubMed, arXiv, Crossref, DOAJ and Europe PMC, with deduplication, 8 export formats and scheduled paper alerts
|
|
5
5
|
Author-email: Balasubramanian Periannan <balathepharmacist@gmail.com>
|
|
6
6
|
Maintainer-email: Balasubramanian Periannan <balathepharmacist@gmail.com>
|
|
7
7
|
License-Expression: MIT
|
|
@@ -18,7 +18,6 @@ Classifier: Topic :: Scientific/Engineering :: Information Analysis
|
|
|
18
18
|
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
|
|
19
19
|
Classifier: Topic :: Text Processing :: General
|
|
20
20
|
Classifier: Programming Language :: Python :: 3
|
|
21
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
22
21
|
Classifier: Programming Language :: Python :: 3.9
|
|
23
22
|
Classifier: Programming Language :: Python :: 3.10
|
|
24
23
|
Classifier: Programming Language :: Python :: 3.11
|
|
@@ -29,7 +28,7 @@ Classifier: Operating System :: POSIX :: Linux
|
|
|
29
28
|
Classifier: Operating System :: MacOS
|
|
30
29
|
Classifier: Operating System :: Microsoft :: Windows
|
|
31
30
|
Classifier: Environment :: Console
|
|
32
|
-
Requires-Python: >=3.
|
|
31
|
+
Requires-Python: >=3.9
|
|
33
32
|
Description-Content-Type: text/markdown
|
|
34
33
|
License-File: LICENSE
|
|
35
34
|
Requires-Dist: biopython>=1.79
|
|
@@ -37,10 +36,10 @@ Requires-Dist: requests>=2.25.0
|
|
|
37
36
|
Requires-Dist: openpyxl>=3.0.0
|
|
38
37
|
Provides-Extra: tui
|
|
39
38
|
Requires-Dist: rich>=13.0.0; extra == "tui"
|
|
40
|
-
Requires-Dist: textual>=4.0.0;
|
|
39
|
+
Requires-Dist: textual>=4.0.0; extra == "tui"
|
|
41
40
|
Provides-Extra: all
|
|
42
41
|
Requires-Dist: rich>=13.0.0; extra == "all"
|
|
43
|
-
Requires-Dist: textual>=4.0.0;
|
|
42
|
+
Requires-Dist: textual>=4.0.0; extra == "all"
|
|
44
43
|
Provides-Extra: dev
|
|
45
44
|
Requires-Dist: pytest>=6.0; extra == "dev"
|
|
46
45
|
Requires-Dist: pytest-cov; extra == "dev"
|
|
@@ -51,9 +50,9 @@ Dynamic: license-file
|
|
|
51
50
|
|
|
52
51
|
# Lixplore-cli
|
|
53
52
|
|
|
54
|
-
> **
|
|
53
|
+
> **A Unix-inspired command-line tool for searching scientific literature**, built for terminal users who want speed, automation and minimal interfaces.
|
|
55
54
|
|
|
56
|
-
[](https://www.python.org/downloads/)
|
|
57
56
|
[](https://opensource.org/licenses/MIT)
|
|
58
57
|
[](https://pryndor.github.io/Lixplore_cli/)
|
|
59
58
|
[](https://github.com/pryndor/Lixplore_cli)
|
|
@@ -62,7 +61,7 @@ Dynamic: license-file
|
|
|
62
61
|
[](https://github.com/pryndor/Lixplore_cli/issues)
|
|
63
62
|
<a href="https://www.buymeacoffee.com/lixplore" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-Support-40DCA5?style=flat&logo=buy-me-a-coffee" alt="Buy Me A Coffee"></a>
|
|
64
63
|
|
|
65
|
-
Search
|
|
64
|
+
Search PubMed, arXiv, Crossref, DOAJ and Europe PMC in one command with Boolean queries, deduplicate the results, and export to 8 formats including BibTeX, RIS, EndNote and Excel. Browse and annotate papers in a full-screen TUI, and get **new-paper alerts** on email, Telegram, Slack and 14 other channels.
|
|
66
65
|
|
|
67
66
|
**📚 [Complete Documentation](https://pryndor.github.io/Lixplore_cli/)** | **🐛 [Report Issues](https://github.com/pryndor/Lixplore_cli/issues)**
|
|
68
67
|
|
|
@@ -78,14 +77,15 @@ Search across multiple academic databases (PubMed, arXiv, Crossref, DOAJ, Europe
|
|
|
78
77
|
- 💾 **8 Export Formats** - CSV, Excel, JSON, BibTeX, RIS, EndNote, XML
|
|
79
78
|
- 📖 **Review Mode** - View articles in separate terminal windows
|
|
80
79
|
- 🎯 **Deduplication** - Advanced duplicate removal with multiple strategies
|
|
81
|
-
- 📁 **Organized Exports** - Auto-organized folders by format type
|
|
80
|
+
- 📁 **Organized Exports** - Auto-organized folders by format type in `./exports/`
|
|
81
|
+
- 📬 **Paper Alerts** - Scheduled digests of new papers on 17 channels, via GitHub Actions or cron
|
|
82
82
|
|
|
83
83
|
### Advanced Features
|
|
84
84
|
- 📥 **PDF Downloads** - Automatic PDF downloads from PMC, arXiv, Unpaywall, and SciHub (optional)
|
|
85
85
|
- 🔗 **PDF Link Display** - Show clickable PDF links for open access articles in terminal (NEW!)
|
|
86
86
|
- 📚 **Reference Manager Integration** - Direct Zotero API integration and Mendeley RIS export
|
|
87
87
|
- 📊 **Statistics Dashboard** - Comprehensive analytics with visualizations (publication trends, top journals, top authors)
|
|
88
|
-
- 🎨 **
|
|
88
|
+
- 🎨 **Full-screen TUI** - Search, read, rate, annotate and export in a Textual interface (`--tui`)
|
|
89
89
|
- 📝 **Citation Export** - Format citations in APA, MLA, Chicago, IEEE styles
|
|
90
90
|
- 🔧 **Custom API Integration** - Plugin architecture for any REST API (Springer, BASE, etc.)
|
|
91
91
|
- 💡 **Metadata Enrichment** - Auto-enrich results from multiple APIs (Crossref, PubMed, arXiv)
|
|
@@ -98,7 +98,7 @@ Search across multiple academic databases (PubMed, arXiv, Crossref, DOAJ, Europe
|
|
|
98
98
|
### Documentation
|
|
99
99
|
- 📚 **[Complete Documentation Site](https://pryndor.github.io/Lixplore_cli/)** - Comprehensive online documentation
|
|
100
100
|
- 📖 **32+ Documentation Pages** - Getting started, user guides, command reference, examples
|
|
101
|
-
- 🔍 **All
|
|
101
|
+
- 🔍 **All 75 Flags Documented** - Detailed examples for every command-line flag
|
|
102
102
|
- 🎓 **Step-by-Step Tutorials** - From installation to advanced workflows
|
|
103
103
|
- 💡 **Quick Examples** - Built-in examples with `--examples` flag
|
|
104
104
|
- 📄 **Man Page** - Traditional Unix man page included
|
|
@@ -149,7 +149,7 @@ lixplore --tui
|
|
|
149
149
|
|
|
150
150
|
**Perfect for scripting, automation, and quick searches**
|
|
151
151
|
|
|
152
|
-
**All
|
|
152
|
+
**All 75 flags fully functional and tested!**
|
|
153
153
|
|
|
154
154
|
```bash
|
|
155
155
|
# Quick search and export
|
|
@@ -166,7 +166,7 @@ lixplore -x -q "quantum computing" -m 25 -X csv,bibtex,ris --zip
|
|
|
166
166
|
```
|
|
167
167
|
|
|
168
168
|
**All Features Available:**
|
|
169
|
-
- ✅
|
|
169
|
+
- ✅ 75 command-line flags
|
|
170
170
|
- ✅ Multi-source search (PubMed, arXiv, Crossref, DOAJ, EuropePMC)
|
|
171
171
|
- ✅ Boolean operators and advanced queries
|
|
172
172
|
- ✅ 8 export formats (CSV, Excel, JSON, BibTeX, RIS, EndNote, XML)
|
|
@@ -180,9 +180,7 @@ lixplore -x -q "quantum computing" -m 25 -X csv,bibtex,ris --zip
|
|
|
180
180
|
|
|
181
181
|
---
|
|
182
182
|
|
|
183
|
-
## 🆕
|
|
184
|
-
|
|
185
|
-
Lixplore has been massively upgraded with powerful new features:
|
|
183
|
+
## 🆕 Feature Highlights
|
|
186
184
|
|
|
187
185
|
### 📥 PDF Download & Link Display
|
|
188
186
|
**Download PDFs** automatically with smart fallback chain:
|
|
@@ -279,7 +277,7 @@ Prefer your own computer? `pip install -U lixplore-cli`, then `lixplore --alerts
|
|
|
279
277
|
|
|
280
278
|
Before installing Lixplore, ensure you have:
|
|
281
279
|
|
|
282
|
-
**Python 3.
|
|
280
|
+
**Python 3.9 or higher:**
|
|
283
281
|
```bash
|
|
284
282
|
python3 --version
|
|
285
283
|
```
|
|
@@ -353,7 +351,7 @@ pip install -e .
|
|
|
353
351
|
|
|
354
352
|
### Optional: Full-screen TUI
|
|
355
353
|
|
|
356
|
-
For `lixplore --tui` (Textual
|
|
354
|
+
For `lixplore --tui` (Textual; without it you get a simpler Rich TUI):
|
|
357
355
|
|
|
358
356
|
```bash
|
|
359
357
|
# With pipx (inject into existing install)
|
|
@@ -363,7 +361,15 @@ pipx inject lixplore-cli rich textual
|
|
|
363
361
|
pip install "lixplore-cli[tui]"
|
|
364
362
|
|
|
365
363
|
# Arch Linux
|
|
366
|
-
sudo pacman -S python-
|
|
364
|
+
sudo pacman -S python-textual
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### 🔑 Optional: PubMed email and API key
|
|
368
|
+
|
|
369
|
+
An NCBI API key raises PubMed's rate limit from 3 to 10 requests per second ([get one free](https://www.ncbi.nlm.nih.gov/account/settings/)). Set `PUBMED_EMAIL` / `PUBMED_API_KEY` in your environment, or create `~/.lixplore/config.json`:
|
|
370
|
+
|
|
371
|
+
```json
|
|
372
|
+
{"pubmed": {"email": "you@example.org", "api_key": "your-ncbi-key"}}
|
|
367
373
|
```
|
|
368
374
|
|
|
369
375
|
### ✅ Verify Installation
|
|
@@ -400,7 +406,7 @@ pip install --user lixplore-cli
|
|
|
400
406
|
|
|
401
407
|
### 🖥️ TUI Mode Troubleshooting (Linux)
|
|
402
408
|
|
|
403
|
-
TUI
|
|
409
|
+
`lixplore --tui` uses [Textual](https://textual.textualize.io/) (≥ 4.0). Without Textual it falls back to a simpler TUI built on `rich` (≥ 13.0). If it fails to launch, follow these steps:
|
|
404
410
|
|
|
405
411
|
#### Step 1 — Run the built-in diagnostics
|
|
406
412
|
|
|
@@ -408,18 +414,18 @@ TUI mode requires the `rich` library (≥ 13.0.0). If it fails to launch, follow
|
|
|
408
414
|
lixplore --check-tui
|
|
409
415
|
```
|
|
410
416
|
|
|
411
|
-
This prints your Python version, Rich status, and exact fix instructions.
|
|
417
|
+
This prints your Python version, Textual and Rich status, and exact fix instructions.
|
|
412
418
|
|
|
413
|
-
#### Step 2 — Install / inject
|
|
419
|
+
#### Step 2 — Install / inject Textual
|
|
414
420
|
|
|
415
421
|
| Installation method | Fix command |
|
|
416
422
|
|---------------------|-------------|
|
|
417
|
-
| **pipx** (most common) | `pipx inject lixplore-cli rich` |
|
|
418
|
-
| **pip + venv** | `pip install
|
|
419
|
-
| **
|
|
420
|
-
| **
|
|
423
|
+
| **pipx** (most common) | `pipx inject lixplore-cli textual rich` |
|
|
424
|
+
| **pip + venv** | `pip install "lixplore-cli[tui]"` (activate venv first) |
|
|
425
|
+
| **Arch Linux (AUR)** | `sudo pacman -S python-textual` |
|
|
426
|
+
| **Homebrew** | included, nothing to install |
|
|
421
427
|
|
|
422
|
-
> **pipx users — common gotcha:** pipx creates an isolated environment per tool. Installing `
|
|
428
|
+
> **pipx users — common gotcha:** pipx creates an isolated environment per tool. Installing `textual` with plain `pip` or `pacman` puts it in a *different* Python environment that lixplore cannot see. Always use `pipx inject lixplore-cli textual rich` so it lands inside the same isolated env.
|
|
423
429
|
|
|
424
430
|
#### Step 3 — Check terminal compatibility
|
|
425
431
|
|
|
@@ -474,20 +480,20 @@ For `screen`, launch it with: `screen -T xterm-256color`
|
|
|
474
480
|
|
|
475
481
|
#### Step 7 — Linux virtual console (tty without a desktop)
|
|
476
482
|
|
|
477
|
-
If you are logged in directly on a raw Linux console (not inside GNOME Terminal, Konsole, etc.) your `TERM` will be `linux`, which does not support 256 colors.
|
|
483
|
+
If you are logged in directly on a raw Linux console (not inside GNOME Terminal, Konsole, etc.) your `TERM` will be `linux`, which does not support 256 colors. The TUI will look broken or fail to render.
|
|
478
484
|
|
|
479
485
|
**Solution:** Log in via SSH from a color-capable terminal, or start a desktop session and use a terminal emulator listed in Step 3 above. Alternatively, use CLI mode (all features work without a terminal emulator).
|
|
480
486
|
|
|
481
487
|
#### ✅ If TUI still doesn't work — use CLI mode
|
|
482
488
|
|
|
483
|
-
All
|
|
489
|
+
All flags work in CLI mode without any extra dependencies. CLI mode is fully production-ready and is what we recommend for scripting, automation, and SSH sessions:
|
|
484
490
|
|
|
485
491
|
```bash
|
|
486
492
|
# CLI equivalents for common TUI workflows
|
|
487
493
|
lixplore -P -q "your topic" -m 20 # search PubMed
|
|
488
494
|
lixplore -A -q "your topic" -m 50 -D # search all + deduplication
|
|
489
495
|
lixplore -P -q "topic" -m 20 -X xlsx # export to Excel
|
|
490
|
-
lixplore -P -q "topic" -m 20 -i #
|
|
496
|
+
lixplore -P -q "topic" -m 20 -i # open the results in the TUI
|
|
491
497
|
```
|
|
492
498
|
|
|
493
499
|
### Basic Usage
|
|
@@ -512,7 +518,7 @@ lixplore -P -q "diabetes" -m 20 -X xlsx -o results.xlsx
|
|
|
512
518
|
Visit our comprehensive documentation site for:
|
|
513
519
|
- **Getting Started Guides** - Installation and first search tutorial
|
|
514
520
|
- **User Guides** - Search, filtering, export, annotations, PDF management
|
|
515
|
-
- **Command Reference** - All
|
|
521
|
+
- **Command Reference** - All 75 flags with detailed examples
|
|
516
522
|
- **Advanced Features** - Automation, AI integration, Zotero, custom APIs
|
|
517
523
|
- **Examples** - Common workflows, use cases, tool integrations
|
|
518
524
|
|
|
@@ -666,7 +672,7 @@ lixplore -P -q "neuroscience" -m 20 -S 2 5 8 -X enw
|
|
|
666
672
|
|
|
667
673
|
## 📊 Export Formats
|
|
668
674
|
|
|
669
|
-
All exports are automatically organized into folders:
|
|
675
|
+
All exports are automatically organized into folders under `exports/` in the folder you run `lixplore` from (use `-o FILE` to choose a path yourself):
|
|
670
676
|
|
|
671
677
|
```
|
|
672
678
|
exports/
|
|
@@ -743,7 +749,7 @@ See [Quick Start](#-quick-start) above for detailed instructions.
|
|
|
743
749
|
|
|
744
750
|
## 🔍 Requirements
|
|
745
751
|
|
|
746
|
-
- Python 3.
|
|
752
|
+
- Python 3.9 or higher
|
|
747
753
|
- Internet connection for API access
|
|
748
754
|
- Terminal emulator (for review feature)
|
|
749
755
|
|
|
@@ -752,9 +758,9 @@ See [Quick Start](#-quick-start) above for detailed instructions.
|
|
|
752
758
|
- `biopython` - PubMed/NCBI API access
|
|
753
759
|
- `requests` - HTTP requests
|
|
754
760
|
- `openpyxl` - Excel export support
|
|
755
|
-
- `rich` (optional) -
|
|
761
|
+
- `textual` + `rich` (optional) - Full-screen TUI
|
|
756
762
|
|
|
757
|
-
All core dependencies are automatically installed. For the
|
|
763
|
+
All core dependencies are automatically installed. For the TUI, install with `pip install "lixplore-cli[tui]"` or `pipx inject lixplore-cli textual rich`.
|
|
758
764
|
|
|
759
765
|
---
|
|
760
766
|
|
|
@@ -819,16 +825,15 @@ Your support enables:
|
|
|
819
825
|
### TUI Mode Enhancement (Active Development)
|
|
820
826
|
We're actively working to bring all CLI features into the TUI mode. Upcoming updates will include:
|
|
821
827
|
|
|
822
|
-
- 🔄 **All
|
|
828
|
+
- 🔄 **All CLI Flags in TUI** - Full integration of all command-line features
|
|
823
829
|
- 📊 **Advanced Filtering** - Date ranges, author search, DOI lookup in TUI
|
|
824
|
-
- 🎨 **Enhanced UI** - Improved navigation and visual design
|
|
825
830
|
- 📥 **PDF Integration** - Direct PDF download and viewing from TUI
|
|
826
831
|
- 🔧 **Custom API Support** - GUI for adding custom data sources
|
|
827
832
|
- 📋 **Profile Management** - Visual interface for export profiles
|
|
828
833
|
- 🎯 **Citation Formatting** - Interactive citation style selection
|
|
829
834
|
- 📈 **Advanced Statistics** - More visualization options
|
|
830
835
|
|
|
831
|
-
**Current Status:**
|
|
836
|
+
**Current Status:** The Textual TUI covers search, reading, rating, annotation, library, alerts, stats and export. Enrichment, citation styles and PDF download are CLI flags for now.
|
|
832
837
|
|
|
833
838
|
---
|
|
834
839
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Lixplore-cli
|
|
2
2
|
|
|
3
|
-
> **
|
|
3
|
+
> **A Unix-inspired command-line tool for searching scientific literature**, built for terminal users who want speed, automation and minimal interfaces.
|
|
4
4
|
|
|
5
|
-
[](https://www.python.org/downloads/)
|
|
6
6
|
[](https://opensource.org/licenses/MIT)
|
|
7
7
|
[](https://pryndor.github.io/Lixplore_cli/)
|
|
8
8
|
[](https://github.com/pryndor/Lixplore_cli)
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
[](https://github.com/pryndor/Lixplore_cli/issues)
|
|
12
12
|
<a href="https://www.buymeacoffee.com/lixplore" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-Support-40DCA5?style=flat&logo=buy-me-a-coffee" alt="Buy Me A Coffee"></a>
|
|
13
13
|
|
|
14
|
-
Search
|
|
14
|
+
Search PubMed, arXiv, Crossref, DOAJ and Europe PMC in one command with Boolean queries, deduplicate the results, and export to 8 formats including BibTeX, RIS, EndNote and Excel. Browse and annotate papers in a full-screen TUI, and get **new-paper alerts** on email, Telegram, Slack and 14 other channels.
|
|
15
15
|
|
|
16
16
|
**📚 [Complete Documentation](https://pryndor.github.io/Lixplore_cli/)** | **🐛 [Report Issues](https://github.com/pryndor/Lixplore_cli/issues)**
|
|
17
17
|
|
|
@@ -27,14 +27,15 @@ Search across multiple academic databases (PubMed, arXiv, Crossref, DOAJ, Europe
|
|
|
27
27
|
- 💾 **8 Export Formats** - CSV, Excel, JSON, BibTeX, RIS, EndNote, XML
|
|
28
28
|
- 📖 **Review Mode** - View articles in separate terminal windows
|
|
29
29
|
- 🎯 **Deduplication** - Advanced duplicate removal with multiple strategies
|
|
30
|
-
- 📁 **Organized Exports** - Auto-organized folders by format type
|
|
30
|
+
- 📁 **Organized Exports** - Auto-organized folders by format type in `./exports/`
|
|
31
|
+
- 📬 **Paper Alerts** - Scheduled digests of new papers on 17 channels, via GitHub Actions or cron
|
|
31
32
|
|
|
32
33
|
### Advanced Features
|
|
33
34
|
- 📥 **PDF Downloads** - Automatic PDF downloads from PMC, arXiv, Unpaywall, and SciHub (optional)
|
|
34
35
|
- 🔗 **PDF Link Display** - Show clickable PDF links for open access articles in terminal (NEW!)
|
|
35
36
|
- 📚 **Reference Manager Integration** - Direct Zotero API integration and Mendeley RIS export
|
|
36
37
|
- 📊 **Statistics Dashboard** - Comprehensive analytics with visualizations (publication trends, top journals, top authors)
|
|
37
|
-
- 🎨 **
|
|
38
|
+
- 🎨 **Full-screen TUI** - Search, read, rate, annotate and export in a Textual interface (`--tui`)
|
|
38
39
|
- 📝 **Citation Export** - Format citations in APA, MLA, Chicago, IEEE styles
|
|
39
40
|
- 🔧 **Custom API Integration** - Plugin architecture for any REST API (Springer, BASE, etc.)
|
|
40
41
|
- 💡 **Metadata Enrichment** - Auto-enrich results from multiple APIs (Crossref, PubMed, arXiv)
|
|
@@ -47,7 +48,7 @@ Search across multiple academic databases (PubMed, arXiv, Crossref, DOAJ, Europe
|
|
|
47
48
|
### Documentation
|
|
48
49
|
- 📚 **[Complete Documentation Site](https://pryndor.github.io/Lixplore_cli/)** - Comprehensive online documentation
|
|
49
50
|
- 📖 **32+ Documentation Pages** - Getting started, user guides, command reference, examples
|
|
50
|
-
- 🔍 **All
|
|
51
|
+
- 🔍 **All 75 Flags Documented** - Detailed examples for every command-line flag
|
|
51
52
|
- 🎓 **Step-by-Step Tutorials** - From installation to advanced workflows
|
|
52
53
|
- 💡 **Quick Examples** - Built-in examples with `--examples` flag
|
|
53
54
|
- 📄 **Man Page** - Traditional Unix man page included
|
|
@@ -98,7 +99,7 @@ lixplore --tui
|
|
|
98
99
|
|
|
99
100
|
**Perfect for scripting, automation, and quick searches**
|
|
100
101
|
|
|
101
|
-
**All
|
|
102
|
+
**All 75 flags fully functional and tested!**
|
|
102
103
|
|
|
103
104
|
```bash
|
|
104
105
|
# Quick search and export
|
|
@@ -115,7 +116,7 @@ lixplore -x -q "quantum computing" -m 25 -X csv,bibtex,ris --zip
|
|
|
115
116
|
```
|
|
116
117
|
|
|
117
118
|
**All Features Available:**
|
|
118
|
-
- ✅
|
|
119
|
+
- ✅ 75 command-line flags
|
|
119
120
|
- ✅ Multi-source search (PubMed, arXiv, Crossref, DOAJ, EuropePMC)
|
|
120
121
|
- ✅ Boolean operators and advanced queries
|
|
121
122
|
- ✅ 8 export formats (CSV, Excel, JSON, BibTeX, RIS, EndNote, XML)
|
|
@@ -129,9 +130,7 @@ lixplore -x -q "quantum computing" -m 25 -X csv,bibtex,ris --zip
|
|
|
129
130
|
|
|
130
131
|
---
|
|
131
132
|
|
|
132
|
-
## 🆕
|
|
133
|
-
|
|
134
|
-
Lixplore has been massively upgraded with powerful new features:
|
|
133
|
+
## 🆕 Feature Highlights
|
|
135
134
|
|
|
136
135
|
### 📥 PDF Download & Link Display
|
|
137
136
|
**Download PDFs** automatically with smart fallback chain:
|
|
@@ -228,7 +227,7 @@ Prefer your own computer? `pip install -U lixplore-cli`, then `lixplore --alerts
|
|
|
228
227
|
|
|
229
228
|
Before installing Lixplore, ensure you have:
|
|
230
229
|
|
|
231
|
-
**Python 3.
|
|
230
|
+
**Python 3.9 or higher:**
|
|
232
231
|
```bash
|
|
233
232
|
python3 --version
|
|
234
233
|
```
|
|
@@ -302,7 +301,7 @@ pip install -e .
|
|
|
302
301
|
|
|
303
302
|
### Optional: Full-screen TUI
|
|
304
303
|
|
|
305
|
-
For `lixplore --tui` (Textual
|
|
304
|
+
For `lixplore --tui` (Textual; without it you get a simpler Rich TUI):
|
|
306
305
|
|
|
307
306
|
```bash
|
|
308
307
|
# With pipx (inject into existing install)
|
|
@@ -312,7 +311,15 @@ pipx inject lixplore-cli rich textual
|
|
|
312
311
|
pip install "lixplore-cli[tui]"
|
|
313
312
|
|
|
314
313
|
# Arch Linux
|
|
315
|
-
sudo pacman -S python-
|
|
314
|
+
sudo pacman -S python-textual
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
### 🔑 Optional: PubMed email and API key
|
|
318
|
+
|
|
319
|
+
An NCBI API key raises PubMed's rate limit from 3 to 10 requests per second ([get one free](https://www.ncbi.nlm.nih.gov/account/settings/)). Set `PUBMED_EMAIL` / `PUBMED_API_KEY` in your environment, or create `~/.lixplore/config.json`:
|
|
320
|
+
|
|
321
|
+
```json
|
|
322
|
+
{"pubmed": {"email": "you@example.org", "api_key": "your-ncbi-key"}}
|
|
316
323
|
```
|
|
317
324
|
|
|
318
325
|
### ✅ Verify Installation
|
|
@@ -349,7 +356,7 @@ pip install --user lixplore-cli
|
|
|
349
356
|
|
|
350
357
|
### 🖥️ TUI Mode Troubleshooting (Linux)
|
|
351
358
|
|
|
352
|
-
TUI
|
|
359
|
+
`lixplore --tui` uses [Textual](https://textual.textualize.io/) (≥ 4.0). Without Textual it falls back to a simpler TUI built on `rich` (≥ 13.0). If it fails to launch, follow these steps:
|
|
353
360
|
|
|
354
361
|
#### Step 1 — Run the built-in diagnostics
|
|
355
362
|
|
|
@@ -357,18 +364,18 @@ TUI mode requires the `rich` library (≥ 13.0.0). If it fails to launch, follow
|
|
|
357
364
|
lixplore --check-tui
|
|
358
365
|
```
|
|
359
366
|
|
|
360
|
-
This prints your Python version, Rich status, and exact fix instructions.
|
|
367
|
+
This prints your Python version, Textual and Rich status, and exact fix instructions.
|
|
361
368
|
|
|
362
|
-
#### Step 2 — Install / inject
|
|
369
|
+
#### Step 2 — Install / inject Textual
|
|
363
370
|
|
|
364
371
|
| Installation method | Fix command |
|
|
365
372
|
|---------------------|-------------|
|
|
366
|
-
| **pipx** (most common) | `pipx inject lixplore-cli rich` |
|
|
367
|
-
| **pip + venv** | `pip install
|
|
368
|
-
| **
|
|
369
|
-
| **
|
|
373
|
+
| **pipx** (most common) | `pipx inject lixplore-cli textual rich` |
|
|
374
|
+
| **pip + venv** | `pip install "lixplore-cli[tui]"` (activate venv first) |
|
|
375
|
+
| **Arch Linux (AUR)** | `sudo pacman -S python-textual` |
|
|
376
|
+
| **Homebrew** | included, nothing to install |
|
|
370
377
|
|
|
371
|
-
> **pipx users — common gotcha:** pipx creates an isolated environment per tool. Installing `
|
|
378
|
+
> **pipx users — common gotcha:** pipx creates an isolated environment per tool. Installing `textual` with plain `pip` or `pacman` puts it in a *different* Python environment that lixplore cannot see. Always use `pipx inject lixplore-cli textual rich` so it lands inside the same isolated env.
|
|
372
379
|
|
|
373
380
|
#### Step 3 — Check terminal compatibility
|
|
374
381
|
|
|
@@ -423,20 +430,20 @@ For `screen`, launch it with: `screen -T xterm-256color`
|
|
|
423
430
|
|
|
424
431
|
#### Step 7 — Linux virtual console (tty without a desktop)
|
|
425
432
|
|
|
426
|
-
If you are logged in directly on a raw Linux console (not inside GNOME Terminal, Konsole, etc.) your `TERM` will be `linux`, which does not support 256 colors.
|
|
433
|
+
If you are logged in directly on a raw Linux console (not inside GNOME Terminal, Konsole, etc.) your `TERM` will be `linux`, which does not support 256 colors. The TUI will look broken or fail to render.
|
|
427
434
|
|
|
428
435
|
**Solution:** Log in via SSH from a color-capable terminal, or start a desktop session and use a terminal emulator listed in Step 3 above. Alternatively, use CLI mode (all features work without a terminal emulator).
|
|
429
436
|
|
|
430
437
|
#### ✅ If TUI still doesn't work — use CLI mode
|
|
431
438
|
|
|
432
|
-
All
|
|
439
|
+
All flags work in CLI mode without any extra dependencies. CLI mode is fully production-ready and is what we recommend for scripting, automation, and SSH sessions:
|
|
433
440
|
|
|
434
441
|
```bash
|
|
435
442
|
# CLI equivalents for common TUI workflows
|
|
436
443
|
lixplore -P -q "your topic" -m 20 # search PubMed
|
|
437
444
|
lixplore -A -q "your topic" -m 50 -D # search all + deduplication
|
|
438
445
|
lixplore -P -q "topic" -m 20 -X xlsx # export to Excel
|
|
439
|
-
lixplore -P -q "topic" -m 20 -i #
|
|
446
|
+
lixplore -P -q "topic" -m 20 -i # open the results in the TUI
|
|
440
447
|
```
|
|
441
448
|
|
|
442
449
|
### Basic Usage
|
|
@@ -461,7 +468,7 @@ lixplore -P -q "diabetes" -m 20 -X xlsx -o results.xlsx
|
|
|
461
468
|
Visit our comprehensive documentation site for:
|
|
462
469
|
- **Getting Started Guides** - Installation and first search tutorial
|
|
463
470
|
- **User Guides** - Search, filtering, export, annotations, PDF management
|
|
464
|
-
- **Command Reference** - All
|
|
471
|
+
- **Command Reference** - All 75 flags with detailed examples
|
|
465
472
|
- **Advanced Features** - Automation, AI integration, Zotero, custom APIs
|
|
466
473
|
- **Examples** - Common workflows, use cases, tool integrations
|
|
467
474
|
|
|
@@ -615,7 +622,7 @@ lixplore -P -q "neuroscience" -m 20 -S 2 5 8 -X enw
|
|
|
615
622
|
|
|
616
623
|
## 📊 Export Formats
|
|
617
624
|
|
|
618
|
-
All exports are automatically organized into folders:
|
|
625
|
+
All exports are automatically organized into folders under `exports/` in the folder you run `lixplore` from (use `-o FILE` to choose a path yourself):
|
|
619
626
|
|
|
620
627
|
```
|
|
621
628
|
exports/
|
|
@@ -692,7 +699,7 @@ See [Quick Start](#-quick-start) above for detailed instructions.
|
|
|
692
699
|
|
|
693
700
|
## 🔍 Requirements
|
|
694
701
|
|
|
695
|
-
- Python 3.
|
|
702
|
+
- Python 3.9 or higher
|
|
696
703
|
- Internet connection for API access
|
|
697
704
|
- Terminal emulator (for review feature)
|
|
698
705
|
|
|
@@ -701,9 +708,9 @@ See [Quick Start](#-quick-start) above for detailed instructions.
|
|
|
701
708
|
- `biopython` - PubMed/NCBI API access
|
|
702
709
|
- `requests` - HTTP requests
|
|
703
710
|
- `openpyxl` - Excel export support
|
|
704
|
-
- `rich` (optional) -
|
|
711
|
+
- `textual` + `rich` (optional) - Full-screen TUI
|
|
705
712
|
|
|
706
|
-
All core dependencies are automatically installed. For the
|
|
713
|
+
All core dependencies are automatically installed. For the TUI, install with `pip install "lixplore-cli[tui]"` or `pipx inject lixplore-cli textual rich`.
|
|
707
714
|
|
|
708
715
|
---
|
|
709
716
|
|
|
@@ -768,16 +775,15 @@ Your support enables:
|
|
|
768
775
|
### TUI Mode Enhancement (Active Development)
|
|
769
776
|
We're actively working to bring all CLI features into the TUI mode. Upcoming updates will include:
|
|
770
777
|
|
|
771
|
-
- 🔄 **All
|
|
778
|
+
- 🔄 **All CLI Flags in TUI** - Full integration of all command-line features
|
|
772
779
|
- 📊 **Advanced Filtering** - Date ranges, author search, DOI lookup in TUI
|
|
773
|
-
- 🎨 **Enhanced UI** - Improved navigation and visual design
|
|
774
780
|
- 📥 **PDF Integration** - Direct PDF download and viewing from TUI
|
|
775
781
|
- 🔧 **Custom API Support** - GUI for adding custom data sources
|
|
776
782
|
- 📋 **Profile Management** - Visual interface for export profiles
|
|
777
783
|
- 🎯 **Citation Formatting** - Interactive citation style selection
|
|
778
784
|
- 📈 **Advanced Statistics** - More visualization options
|
|
779
785
|
|
|
780
|
-
**Current Status:**
|
|
786
|
+
**Current Status:** The Textual TUI covers search, reading, rating, annotation, library, alerts, stats and export. Enrichment, citation styles and PDF download are CLI flags for now.
|
|
781
787
|
|
|
782
788
|
---
|
|
783
789
|
|
|
@@ -26,7 +26,7 @@ docs/
|
|
|
26
26
|
│ ├── custom-apis.md # Custom API integration
|
|
27
27
|
│ └── zotero.md # Zotero integration
|
|
28
28
|
├── reference/ # Command reference
|
|
29
|
-
│ ├── flags-overview.md # All
|
|
29
|
+
│ ├── flags-overview.md # All flags overview
|
|
30
30
|
│ ├── source-flags.md # Source selection flags
|
|
31
31
|
│ ├── search-flags.md # Search parameter flags
|
|
32
32
|
│ ├── filter-flags.md # Filtering flags
|
|
@@ -18,7 +18,7 @@ No. Lixplore is purely a search and export tool. It has no machine learning depe
|
|
|
18
18
|
|
|
19
19
|
### What platforms does Lixplore support?
|
|
20
20
|
|
|
21
|
-
Lixplore works on Linux, macOS, and Windows with Python 3.
|
|
21
|
+
Lixplore works on Linux, macOS, and Windows with Python 3.9 or higher.
|
|
22
22
|
|
|
23
23
|
---
|
|
24
24
|
|
|
@@ -27,7 +27,7 @@ Lixplore works on Linux, macOS, and Windows with Python 3.8 or higher.
|
|
|
27
27
|
### How do I install Lixplore?
|
|
28
28
|
|
|
29
29
|
```bash
|
|
30
|
-
pip install lixplore
|
|
30
|
+
pip install lixplore-cli
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
See the [Installation Guide](../getting-started/installation.md) for details.
|
|
@@ -45,7 +45,7 @@ Add this to your `~/.bashrc` or `~/.zshrc` to make it permanent.
|
|
|
45
45
|
### How do I upgrade to the latest version?
|
|
46
46
|
|
|
47
47
|
```bash
|
|
48
|
-
pip install --upgrade lixplore
|
|
48
|
+
pip install --upgrade lixplore-cli
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
---
|
|
@@ -480,7 +480,7 @@ jobs:
|
|
|
480
480
|
python-version: '3.10'
|
|
481
481
|
|
|
482
482
|
- name: Install Lixplore
|
|
483
|
-
run: pip install lixplore
|
|
483
|
+
run: pip install lixplore-cli
|
|
484
484
|
|
|
485
485
|
- name: Run literature search
|
|
486
486
|
run: |
|
|
@@ -520,7 +520,7 @@ literature_search:
|
|
|
520
520
|
stage: search
|
|
521
521
|
image: python:3.10
|
|
522
522
|
script:
|
|
523
|
-
- pip install lixplore
|
|
523
|
+
- pip install lixplore-cli
|
|
524
524
|
- TODAY=$(date +%Y-%m-%d)
|
|
525
525
|
- YESTERDAY=$(date -d "yesterday" +%Y-%m-%d)
|
|
526
526
|
- lixplore -A -q "$TOPIC" -d "$YESTERDAY" "$TODAY" -m 100 -D -X json -o results.json
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Before installing Lixplore, ensure you have:
|
|
6
6
|
|
|
7
|
-
### 1. Python (Version 3.
|
|
7
|
+
### 1. Python (Version 3.9 or Higher)
|
|
8
8
|
|
|
9
9
|
Check your Python version:
|
|
10
10
|
|
|
@@ -252,7 +252,7 @@ Check your Python version:
|
|
|
252
252
|
python3 --version
|
|
253
253
|
```
|
|
254
254
|
|
|
255
|
-
If it's below 3.
|
|
255
|
+
If it's below 3.9, you need to upgrade Python:
|
|
256
256
|
- **Windows**: Download from [python.org](https://www.python.org/downloads/)
|
|
257
257
|
- **Mac**: `brew install python3`
|
|
258
258
|
- **Linux**: `sudo apt install python3.10` (or newer)
|
|
@@ -11,7 +11,7 @@ lixplore --tui # open the TUI
|
|
|
11
11
|
lixplore -P -q "CRISPR" -m 50 -i # run a CLI search, then browse it in the TUI
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Without Textual installed, these commands open the older Rich-based TUI instead. `lixplore --check-tui` reports what is installed and how to fix it.
|
|
15
15
|
|
|
16
16
|
## Layout
|
|
17
17
|
|