# S. Delorme, L. Mach,
# H. Paszkiewicz, & R. Ruiz
# 2025 September
# 
# BibAPI (bibAPI.py)
# https://arxiv.org/abs/2509.09601
# https://gitlab.cern.ch/riruiz/public-projects/-/tree/master/BibAPI/
# CC-BY-4.0 license

1. bibAPI.py is a farm-to-table, data-analysis pipeline that collects (harvests), processes, and plots bibliometric data common to the ArXiv and InSpireHEP. The program was authored by two undergraduate physics students (Mach & Paszkiewicz) as part of the 2024 edition of the IFJ PAN's summer research experience for undergraduate program (https://ppss.ifj.edu.pl/). The script is available publicly to support the introduction of data science methods in undergraduate courses in physics & astronomy. For further details, please see https://arxiv.org/abs/2509.09601
and the project home
https://gitlab.cern.ch/riruiz/public-projects/-/tree/master/BibAPI/

2. Directory contents:
- README.txt (this file)
- bibAPI.py (main program)
- apiFlow_ArXivInSpire.png (pipeline flow)
- apiFlow_SocialMediaBot.png (extended pipeline flow)
- ifjnz42_socials_API_kingdom.py (template API keys for posting to social media)
- ResultsFromPaper (folder with results from 2509.09601)
-- 1991_to_2025 (folder with results from 34-year run)
-- 2022 (folder with results from 1-year run)

3. Usage:
# usage (option 1): $ python ./bibAPI.py
# usage (option 2): $ python ./bibAPI.py YYYY-MM-DD YYYY-MM-DD
# usage (option 3): $ python ./bibAPI.py YYYY-MM-DD YYYY-MM-DD CAT1 CAT2 ...
# usage (option 4): $ python ./bibAPI.py --help

