Getting Started with PyEuropePMC
**π Welcome to PyEuropePMC!** Get up and running in minutes.
[π¦ Installation](/pyEuropePMC/getting-started/installation.html) β’ [β‘ Quick Start](/pyEuropePMC/getting-started/quickstart.html) β’ [β FAQ](/pyEuropePMC/getting-started/faq.html) β’ [β¬
οΈ Back to Docs](/pyEuropePMC/)
π Prerequisites
Before you begin, ensure you have:
- Python 3.10 or higher installed
- pip or poetry for package management
- Basic familiarity with Python programming
- (Optional) A text editor or IDE
π Quick Navigation
| Document | Description | Time | Difficulty |
|---|---|---|---|
| π¦ Installation | Install PyEuropePMC and dependencies | 2 min | β Beginner |
| β‘ Quick Start | Your first search and extraction | 5 min | β Beginner |
| β FAQ | Common questions and troubleshooting | 10 min | β Beginner |
π Recommended Learning Path
### Step 1: Installation (2 minutes)
Start with the [Installation Guide](/pyEuropePMC/getting-started/installation.html) to get PyEuropePMC installed on your system.
```bash
pip install pyeuropepmc
```
### Step 2: Quick Start (5 minutes)
Follow the [Quick Start Guide](/pyEuropePMC/getting-started/quickstart.html) to run your first search:
```python
from pyeuropepmc import SearchClient
with SearchClient() as client:
results = client.search("CRISPR", pageSize=10)
print(f"Found {results['hitCount']} papers")
```
### Step 3: Explore Features
Once you've completed the quick start, explore specific features:
- **[π Search](../features/search/)** - Advanced search capabilities
- **[π Full-Text](../features/fulltext/)** - Download PDFs and XML
- **[π¬ Parsing](../features/parsing/)** - Extract structured data from XML
π― What Youβll Learn
After completing this section, youβll be able to:
- β Install and configure PyEuropePMC
- β Perform basic searches
- β Download full-text content
- β Parse XML documents
- β Extract metadata and tables
- β Handle common errors
π‘ Next Steps
Once youβre comfortable with the basics:
- Dive deeper into Features to see whatβs possible
- Study the API Reference for complete documentation
- Explore Examples for real-world use cases
- Learn Advanced techniques for power users
π Need Help?
- Check the FAQ for common questions
- See Examples for working code
- Visit GitHub Issues for support
π Related Sections
| Section | Why Visit? |
|---|---|
| Features | Learn what PyEuropePMC can do |
| API Reference | Complete method documentation |
| Examples | Working code samples |
| Advanced | Power user features |
**Ready to begin?** [π¦ Start with Installation β](/pyEuropePMC/getting-started/installation.html)
**[β¬ Back to Top](#getting-started-with-pyeuropepmc)** β’ [β¬
οΈ Back to Main Docs](/pyEuropePMC/)