https://github.com/sdruskat/cfftracker

Tracks `CITATION.cff` files across public repositories
https://github.com/sdruskat/cfftracker

Last synced: about 1 month ago
JSON representation

Tracks `CITATION.cff` files across public repositories

• Host: GitHub
• URL: https://github.com/sdruskat/cfftracker
• Owner: sdruskat
• License: mit
• Created: 2021-08-16T09:47:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T22:21:33.000Z (about 1 month ago)
• Last Synced: 2025-04-09T23:25:50.165Z (about 1 month ago)
• Language: Python
• Size: 18.7 MB
• Stars: 9
• Watchers: 3
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        


:warning: Due to changes in the GitHub Search API, these data currently aren't reliable.

# cfftracker

Tracks `CITATION.cff` files across public repositories on GitHub.

## Current count: 0

![A graph showing a timeline of file counts for CITATION.cff files across GitHub retrieved via GitHub search API.](cff_counts_clean.png)

Note: This plot has been produced on cleaned up data that disregards drops in counts of > 100.

These steep drops are due to temporal unreliabilities in results from the GitHub Search API, 

caused by backend work on GitHub at the time of the query (source: personal communication with GitHub staff).

For a plot of the uncleaned data, see [cff_counts.png](cff_counts.png).

## Documentation

The tracker uses a [GitHub Action workflow](.github/workflows/update.yml) to [query](query_api.py) the [GitHub Search API](https://docs.github.com/en/rest/reference/search) (basically an authenticated call to  `https://api.github.com/search/code?q=filename:CITATION.cff`) for files with the filename `CITATION.cff`.

The total count is then extracted from the API response, added with the current date to a [CSV file](cff_counts.csv), written to a [text file](current_count.txt) (for easy extraction), and put in `README.md` using regex replacement for the `## Current count: nnnn` line.

[Another script](clean_plot.py) using [pandas](https://pandas.pydata.org/) and [matplotlib](https://matplotlib.org/) creates the graph you see above.

And finally, all updated files are committed and pushed back into this repository.

## Licenses

Copyright © 2021 Stephan Druskat

This work is licensed under multiple licenses:

Code is licensed under MIT.

Documentation files and images are licensed under CC-BY-4.0.

The remaining files are licensed under CC0-1.0.

Please see the individual files for more accurate information.