How sri0606/pyorcid works
Main Components
a) Client Layer:
• PyOrcid Library Interface
• Authentication Module
• Data Access Modules
• Search Module
• Scrapper Module
b) External Systems:
• ORCID Public API
• ORCID Member API
• ORCID Public Database (for scraping)
┌─ Client Applications ─────────────────────────────────────┐
• Uses PyOrcid Library │
• ┤
• PyOrcid Library │
• ┬──────────────┬────────────┬───────────────┤
• OrcidAuth │ Orcid │ OrcidSearch│ OrcidScrapper │
• ┴──────────────┴────────────┴───────────────┤
• External Services │
• ORCID Public API ORCID Member API ORCID Web │
• ┘
Component Details
For each major component, include:
a) OrcidAuthentication:
• Input: client_id, client_secret, redirect_uri
• Output: access_token
• Methods: get_public_access_token(), get_private_access_token()
b) Orcid:
• Input: orcid_id, orcid_access_token, state
• Methods: works(), generate_markdown_file()
• Handles API interactions
c) OrcidSearch:
• Input: orcid_access_token
• Methods: search()
• Handles search functionality
d) OrcidScrapper:
• Input: orcid_id
• Inherits from Orcid
• Web scraping alternative
Data Flow Indicators
Following flows:
• Authentication flow (client → OrcidAuth → ORCID API)
• Data retrieval flow (client → Orcid → ORCID API)
• Search flow (client → OrcidSearch → ORCID API)
• Scraping flow (client → OrcidScrapper → ORCID Web)
Important Notes
• Two access paths (API vs. Scrapper)
• Authentication requirements for different access levels
• Inheritance relationship between Orcid and OrcidScrapper
• Error handling paths
• Data transformation flows