Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
some-natalie committed Apr 14, 2022
1 parent 26264db commit 2b1b5b3
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# GitHub Advanced Security to CSV

Simple GitHub Action to scrape the GitHub Advanced Security API and shove it into a CSV.
Simple GitHub Action to scrape the GitHub Advanced Security API and shove it into a CSV.

## Why?

Because I really want to see this data for a repository as a time-series to understand it, and [Flat Data](https://next.github.com/projects/flat-data/) doesn't support paginated APIs (yet?) ... so ... it's really an experiment and I wanted to play around with the shiny new toy.

Also ... CSV files are the dead-simple ingest point for a ton of other software services you might ~~want~~ have to use in business. And some people just like CSV files and want to do things in spreadsheets and I'm not here to judge that. Shine on, you spreadsheet gurus! :sparkles:

## How
## How?

This got a little more complicated than I'd like, but the tl;dr of what I'm trying to figure out is below:

Expand Down Expand Up @@ -102,3 +102,7 @@ jobs:
```gitignore
nginx-pid/
```

## Notes

[GitHub Copilot](https://copilot.github.com/) wrote most of the Python code in this project. I mostly just structured the files/functions, wrote some docstrings, accounted for the differences in API versions across the products, and edited what it gave me. :heart:

0 comments on commit 2b1b5b3

Please sign in to comment.