A Google Cloud Function for reporting GitHub activity on a regular basis.
pipenv is used for development/debugging.
To add a dependency (add --dev if necessary):
$ pipenv install <my_dep>
To update all dependencies:
$ pipenv update --outdated
After removing a dependency, you can remove it from the enviroment with:
$ pipenv clean
We need a requirements.txt because that's what Google wants. Generate / keep it up to date with:
$ pipenv lock -r > requirements.txt
Make sure you have development dependencies installed (pipenv install --dev) and then:
$ pipenv run py.test
If a secrets.json file exists in the same directory as main.py, the required keys will be read from it. Otherwise, the application will look for the following environment variables, which must be set when the function is deployed. The following must be set:
GITHUB_TOKEN(See https://github.com/settings/tokens)GITHUB_ORGANIZATION
Sample secrets.json:
{
"GITHUB_TOKEN":"1a2b3c4d5e6f7g8h9i0k",
"GITHUB_ORGANIZATION":"my_org"
}PyGithub doesn't do a great job of memoizing API responses (i.e. it makes several repetitive calls), so requests-cache is used to speed things up and help keep us from hitting the GitHub API request limit. API responses are cached locally for 5 minutes in memory. This should all happen perfectly transparently. Just letting you know.
Issues changed over the past 24 hours are reported. This is presently hard-coded but could be made a configuration option (as an arg to a timedelta?) in the future.
When in doubt, run Black
$ pipenv run black -t py37 -l 79 github_reporter/ main.py
https://gist.github.com/jpstroop/6ed0c98f6a960f69f8142b56064cdb84
...isn't too pretty. To work on it, start a server with:
$ pipenv run python -m http.server
and visit http://localhost:8000/docs/
Reports are serialized as JSON data, with issues grouped using the repository name as the key. The structure is as follows:
{
"today": "2019-09-27T00:01:07",
"yesterday": "2019-09-26T00:01:07",
"repo_name": [
{
"created_at": "2019-09-25T17:51:05",
"html_url": "https://github.com/my_org/repo_name/pull/42",
"number": 42,
"pull_request_html_url": "https://github.com/my_org/repo_name/pull/42",
"repository_html_url": "https://github.com/my_org/repo_name",
"state": "closed",
"title": "The widget is broken",
"user_name": null,
"comments": [
{
"user_name": "Abe Developer",
"updated_at": "2019-09-26T15:05:47",
"html_url": "https://github.com/my_org/repo_name/pull/42#issuecomment-535137315",
"body": "Fixes all the things (note that this could contain Markdown)"
}
],
"events": [
{
"actor_name": "Ann Actor",
"created_at": "2019-09-26T17:42:41",
"type": "merged"
},
{
"actor_name": "Ann Actor",
"created_at": "2019-09-26T17:42:41",
"type": "closed"
}
]
},
{
"created_at": "2019-09-26T17:48:22",
"html_url": "https://github.com/my_org/repo_name/issues/496",
"number": 496,
"pull_request_html_url": null,
"repository_html_url": "https://github.com/my_org/repo_name",
"state": "open",
"title": "Fixes one more thin",
"user_name": null,
"comments": [],
"events": []
}
],
"repo_name1": [
{
"created_at": "2019-09-26T15:31:16",
// ...
}
]
}