paper-search-cli 0.1.0

package/.env.example

@@ -0,0 +1,165 @@
+# ==============================================================================
+# Paper Search CLI - Environment Variables
+# ==============================================================================
+# Supports 20 academic sources/platforms with a unified CLI interface
+# Platforms: Crossref, OpenAlex, PubMed, PubMed Central, Europe PMC, arXiv,
+# bioRxiv, medRxiv, Semantic Scholar, CORE, OpenAIRE, Web of Science,
+# Google Scholar, IACR ePrint, Sci-Hub, ScienceDirect, Springer, Wiley,
+# Scopus, Unpaywall
+#
+# For global installs, prefer:
+#   paper-search config set KEY VALUE
+# The user-level config path is:
+#   ~/.config/paper-search-cli/config.json
+
+# ==============================================================================
+# API KEYS CONFIGURATION
+# ==============================================================================
+
+# ------------------------------------------------------------------------------
+# Web of Science (Clarivate) - REQUIRED
+# ------------------------------------------------------------------------------
+# Premium citation database with high-quality journal indexing
+# Get API key: https://developer.clarivate.com/apis
+# Pricing: Paid subscription required
+# Rate limit: Depends on subscription level
+WOS_API_KEY=your_web_of_science_api_key_here
+WOS_API_VERSION=v1
+
+# ------------------------------------------------------------------------------
+# PubMed/NCBI E-utilities - OPTIONAL (but recommended)
+# ------------------------------------------------------------------------------
+# Biomedical literature database
+# Without API key: 3 requests/second limit
+# With API key: 10 requests/second limit
+# Get API key: https://ncbiinsights.ncbi.nlm.nih.gov/2017/11/02/new-api-keys-for-the-e-utilities/
+# Pricing: Free
+PUBMED_API_KEY=your_ncbi_api_key_here
+NCBI_EMAIL=you@example.com
+NCBI_TOOL=paper-search-cli
+
+# ------------------------------------------------------------------------------
+# Semantic Scholar - OPTIONAL (increases rate limits)
+# ------------------------------------------------------------------------------
+# AI-powered academic search with semantic understanding
+# Required for search_semantic_snippets; strongly recommended for normal search
+# Without API key: ~20 requests/minute (free tier)
+# With API key: ~180 requests/minute (partner tier)
+# Get API key: https://www.semanticscholar.org/product/api
+# Pricing: Free for academic use
+SEMANTIC_SCHOLAR_API_KEY=your_semantic_scholar_api_key_here
+
+# ------------------------------------------------------------------------------
+# Unpaywall - REQUIRED for DOI-based open-access resolution
+# ------------------------------------------------------------------------------
+# Used by search_unpaywall and download_with_fallback
+# Get details: https://unpaywall.org/products/api
+# Pricing: Free, but requires a contact email
+PAPER_SEARCH_UNPAYWALL_EMAIL=you@example.com
+# Legacy-compatible fallback name
+UNPAYWALL_EMAIL=you@example.com
+
+# ------------------------------------------------------------------------------
+# CORE - OPTIONAL (but recommended)
+# ------------------------------------------------------------------------------
+# Open repository metadata and PDF candidates
+# Anonymous access can be heavily rate-limited
+# Get API key: https://core.ac.uk/services/api
+# Pricing: Free tier available
+PAPER_SEARCH_CORE_API_KEY=your_core_api_key_here
+# Legacy-compatible fallback name
+CORE_API_KEY=your_core_api_key_here
+
+# ------------------------------------------------------------------------------
+# OpenAIRE - OPTIONAL
+# ------------------------------------------------------------------------------
+# Open repository discovery source; public search usually works without a key
+# API docs: https://develop.openaire.eu/
+PAPER_SEARCH_OPENAIRE_API_KEY=your_openaire_api_key_here
+# Legacy-compatible fallback name
+OPENAIRE_API_KEY=your_openaire_api_key_here
+
+# ------------------------------------------------------------------------------
+# Elsevier API - REQUIRED for ScienceDirect and Scopus
+# ------------------------------------------------------------------------------
+# Single API key works for both platforms:
+# - ScienceDirect: Full-text scientific database
+# - Scopus: Largest abstract and citation database
+# Get API key: https://dev.elsevier.com/apikey/manage
+# Pricing: Free tier available with usage limits
+# Rate limit: 10 requests/second with key, 20 requests/minute without
+ELSEVIER_API_KEY=your_elsevier_api_key_here
+
+# ------------------------------------------------------------------------------
+# Springer Nature API - REQUIRED for Springer
+# ------------------------------------------------------------------------------
+# Dual API system:
+# - Metadata API v2: Search all Springer content (subscription + open access)
+#   Endpoint: https://api.springernature.com/meta/v2/json
+# - OpenAccess API: Search and download open access papers only
+#   Endpoint: https://api.springernature.com/openaccess/json
+#   Note: OpenAccess API may require special permissions on your API key
+#
+# Get API key: https://dev.springernature.com/signup
+# Documentation: https://dev.springernature.com/
+# Pricing: Free with 5000 requests/day limit (shared between both APIs)
+# Rate limit: ~200 requests/hour (conservative)
+#
+# Primary API key (required - works for Metadata API v2)
+SPRINGER_API_KEY=your_springer_api_key_here
+#
+# Optional: Separate OpenAccess API key (if different from main key)
+# Only set this if you have a separate key specifically for OpenAccess API
+# SPRINGER_OPENACCESS_API_KEY=your_openaccess_api_key_here
+
+# ------------------------------------------------------------------------------
+# Wiley Text and Data Mining (TDM) - REQUIRED for Wiley
+# ------------------------------------------------------------------------------
+# Access to Wiley Online Library for text and data mining
+# Get TDM token: https://onlinelibrary.wiley.com/library-info/resources/text-and-datamining
+# Pricing: Requires institutional affiliation or subscription
+# Rate limit: ~100 requests/hour (conservative estimate)
+WILEY_TDM_TOKEN=your_wiley_tdm_token_here
+
+# ==============================================================================
+# PLATFORM STATUS SUMMARY
+# ==============================================================================
+# 
+# Platform          | API Key    | Features                      | Best For
+# ------------------|------------|-------------------------------|------------------
+# Crossref          | ✅ Free    | Broad metadata, citations     | Default search
+# OpenAlex          | ✅ Free    | Broad metadata, OA locations  | Open discovery
+# arXiv             | ✅ Free    | Preprints, PDF download       | Physics, CS, Math
+# Web of Science    | 🔴 Required| Citation analysis, metrics   | Impact research
+# PubMed            | 🟡 Optional| Medical literature            | Biomedical
+# PubMed Central    | ✅ Free    | Open full text, PDFs          | Biomedical OA
+# Europe PMC        | ✅ Free    | Open links, biomedical data   | Biomedical OA
+# Google Scholar    | ✅ Free    | Comprehensive coverage        | General search
+# bioRxiv           | ✅ Free    | Biology preprints, PDF        | Biology research
+# medRxiv           | ✅ Free    | Medical preprints, PDF        | Medical research
+# Semantic Scholar  | 🟡 Optional| AI-powered search, citations  | CS, AI research
+# CORE              | 🟡 Optional| Repository PDFs               | Open repositories
+# OpenAIRE          | 🟡 Optional| Repository discovery          | Open repositories
+# Unpaywall         | 📧 Email   | DOI OA resolution             | Fallback downloads
+# IACR ePrint       | ✅ Free    | Cryptography papers, PDF      | Cryptography
+# Sci-Hub          | ✅ Free    | Universal DOI access          | Any paper by DOI
+# ScienceDirect     | 🔴 Required| Elsevier journals             | Full-text search
+# Springer          | 🔴 Required| Dual API (Meta+OpenAccess)    | Books & journals
+# Wiley             | 🔴 Required| TDM API, full text mining     | Data mining
+# Scopus            | 🔴 Required| Citation database             | Bibliometrics
+#
+# Legend: ✅ No key needed | 🟡 Optional key | 🔴 Key required | 📧 Email required
+
+# ==============================================================================
+# CLI RUNTIME CONFIGURATION
+# ==============================================================================
+NODE_ENV=production
+LOG_LEVEL=info
+
+# Download Configuration
+DEFAULT_DOWNLOAD_PATH=./downloads
+MAX_FILE_SIZE_MB=100
+
+# Rate Limiting
+RATE_LIMIT_REQUESTS_PER_MINUTE=60
+RATE_LIMIT_BURST=10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dianel555
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.