PyEuropePMC Documentation

[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Tests](https://img.shields.io/badge/tests-200%2B%20passed-green.svg)](../tests/) **Complete documentation for PyEuropePMC** - A robust Python toolkit for scientific literature analysis from Europe PMC [🚀 Quick Start](/pyEuropePMC/getting-started/quickstart.html) • [📚 API Reference](api/) • [🎯 Examples](examples/) • [🗺️ Site Map](/pyEuropePMC/sitemap.html) • [GitHub](https://github.com/JonasHeinickeBio/pyEuropePMC)

📖 Documentation Overview

Welcome to the PyEuropePMC documentation! This site is organized to help you find what you need quickly, whether you’re new to the library or a power user.

🗂️ Site Structure

📚 PyEuropePMC Documentation
├── 🚀 [Getting Started](getting-started/) - Installation & basics
│   ├── 📦 [Installation](/pyEuropePMC/getting-started/installation.html)
│   ├── ⚡ [Quick Start](/pyEuropePMC/getting-started/quickstart.html)
│   └── ❓ [FAQ](/pyEuropePMC/getting-started/faq.html)
├── ✨ [Features](features/) - What PyEuropePMC can do
│   ├── 🔍 [Search](features/search/)
│   ├── 🔧 [Query Builder](/pyEuropePMC/features/query-builder-load-save-translate.html)
│   ├── 📄 [Full-Text](features/fulltext/)
│   ├── 🔬 [XML Parsing](features/parsing/)
│   └── 📋 [Systematic Reviews](/pyEuropePMC/features/systematic-review-tracking.html)
├── 📚 [API Reference](api/) - Complete API docs
│   ├── 🔍 [SearchClient](/pyEuropePMC/api/search-client.html)
│   ├── 📄 [FullTextClient](/pyEuropePMC/api/fulltext-client.html)
│   ├── 📄 [ArticleClient](/pyEuropePMC/api/article-client.html)
│   ├── 🔬 [XML Parser](/pyEuropePMC/api/xml-parser.html)
│   └── 📦 [FTP Downloader](/pyEuropePMC/api/ftp-downloader.html)
├── 🎯 [Examples](examples/) - Code examples & use cases
├── ⚙️ [Advanced](advanced/) - Power user features
└── 🛠️ [Development](development/) - Contributing & development

🎯 Quick Navigation

I want to… Go to… Time
Install PyEuropePMC Installation 2 min
Run my first search Quick Start 5 min
Search for papers Search Features 10 min
Build complex queries Query Builder 15 min
Download PDFs/XML Full-Text Retrieval 10 min
Parse XML documents XML Parsing 15 min
Extract metadata/tables XML Parser API 20 min
See working examples Examples 10-30 min
Optimize performance Advanced Features 20 min
Contribute code Development 30 min

🚀 Getting Started (Recommended Path)

1. **📦 [Install](/pyEuropePMC/getting-started/installation.html)** (2 min) ```bash pip install pyeuropepmc ``` 2. **⚡ [Quick Start](/pyEuropePMC/getting-started/quickstart.html)** (5 min) ```python from pyeuropepmc.search import SearchClient with SearchClient() as client: results = client.search("CRISPR", pageSize=10) ``` 3. **🔍 [Explore Features](features/)** (10-30 min) - [Search](features/search/) - Query Europe PMC - [Full-Text](features/fulltext/) - Download content - [Parsing](features/parsing/) - Extract structured data 4. **📚 [API Reference](api/)** (as needed) - Complete method documentation - Parameter details & examples

📋 Feature Overview

🔍 Search & Query

📄 Content Retrieval

🔬 Data Extraction

📊 Analytics & Processing

🛠️ Developer Features

🎓 Learning Paths

👨‍🎓 For Beginners

graph TD
    A[Installation] --> B[Quick Start]
    B --> C[Basic Search]
    C --> D[Download Content]
    D --> E[Parse XML]
    E --> F[Examples]
  1. Installation → Quick Start
  2. Search Features → Full-Text
  3. Examples → API Reference

👨‍💼 For Researchers

graph TD
    A[Query Builder] --> B[Systematic Reviews]
    B --> C[Advanced Search]
    C --> D[Bulk Downloads]
    D --> E[Analytics]
  1. Query Builder → Systematic Reviews
  2. Advanced Search → Bulk Operations
  3. Analytics → Performance

👨‍💻 For Developers

graph TD
    A[API Reference] --> B[Advanced Features]
    B --> C[Caching]
    C --> D[Error Handling]
    D --> E[Contributing]
  1. API Reference → Advanced
  2. Caching → Performance
  3. Development → Contributing

🔍 Search & Discovery

By Topic

Topic Primary Location Related
Installation Getting Started FAQ
Search Queries Search Query Builder
Full-Text Full-Text FTP Downloads
XML Parsing Parsing XML Parser
Systematic Reviews Reviews Query Builder
Analytics Analytics Examples
Performance Advanced Caching
Contributing Development GitHub

By Task

I need to… Solution
Find papers on a topic Search Features
Download PDFs in bulk FTP Downloader
Extract tables from papers XML Parsing
Build reproducible searches Systematic Reviews
Analyze citation patterns Analytics
Optimize API performance Caching
Handle API errors Error Handling

📦 What’s New in v1.11.3

✨ Major Features

🔧 Improvements

See CHANGELOG for complete version history.

🆘 Getting Help

Quick Help

Community Support

Report Issues

Found a bug or need help? Create an issue with:

🔗 External Links

**📚 [Browse All Documentation](#) • 🚀 [Quick Start](/pyEuropePMC/getting-started/quickstart.html) • 💡 [Examples](examples/)** --- **[⬆ Back to Top](#pyeuropepmc-documentation)** *Made with ❤️ by the PyEuropePMC team • Licensed under [MIT](../LICENSE)*