Skip to content

Tracks `CITATION.cff` files across public repositories

License

Notifications You must be signed in to change notification settings

sdruskat/cfftracker

Repository files navigation

⚠️ 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.

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.

Documentation

The tracker uses a GitHub Action workflow to query the GitHub Search API (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, written to a text file (for easy extraction), and put in README.md using regex replacement for the ## Current count: nnnn line.

Another script using pandas and matplotlib 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.

About

Tracks `CITATION.cff` files across public repositories

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages