{"id":22382879,"url":"https://github.com/wietze/github-checks-api","last_synced_at":"2025-07-31T04:31:30.364Z","repository":{"id":53105411,"uuid":"201666496","full_name":"wietze/github-checks-api","owner":"wietze","description":"A lightweight python3 implementation of the GitHub Checks API for CI testing.","archived":true,"fork":false,"pushed_at":"2021-04-06T15:04:12.000Z","size":31,"stargazers_count":9,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T13:12:12.101Z","etag":null,"topics":["github-checks"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wietze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-10T18:10:58.000Z","updated_at":"2024-11-10T06:33:46.000Z","dependencies_parsed_at":"2022-09-03T08:33:35.482Z","dependency_job_id":null,"html_url":"https://github.com/wietze/github-checks-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wietze/github-checks-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wietze%2Fgithub-checks-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wietze%2Fgithub-checks-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wietze%2Fgithub-checks-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wietze%2Fgithub-checks-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wietze","download_url":"https://codeload.github.com/wietze/github-checks-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wietze%2Fgithub-checks-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267988295,"owners_count":24176990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-checks"],"created_at":"2024-12-05T00:42:14.162Z","updated_at":"2025-07-31T04:31:30.124Z","avatar_url":"https://github.com/wietze.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-checks-api\n[GitHub Checks](https://developer.github.com/v3/checks/) allows you to quickly see the results of your CI tests from GitHub.\n\n\nThis is a simple, light-weight python implementation of the GitHub Checks API.\n\n# Examples\nOnce you have completed all the installation steps, here are a few examples of what your Checks implementation could look like:\n\nAutomatically run Checks for new commits:\n![](docs/example-2.png)\n\nAnnotate files with messages explaining why they failed tests:\n![](docs/example.png)\n\n# Installation\n\nNote that you need a self-hosted server that will run your CI logic. \n\n## 1: Creating a new GitHub app\nIn GitHub, do the following:\n1. Click your profile in the right top corner, click _Settings_, click _Developers Settings_, click _GitHub Apps_ and click _New GitHub App_.\n2. Add a name and homepage URL (any URL will do). For _User authorization callback URL_ and _Webhook URL_, use the server address you'll be using, with `/hook` at the end of the address.\n3. Generate a strong, random secret and set it as _Webhook secret (optional)_. While optional in GitHub, this project won't work without one.\n4. Under _Permissions_, set the following: \n\n   |Name|Permission| \n   |----|----------| \n   |**Checks**|Read \u0026 write| \n   |**Repository contents**|Read| \n   |**Repository metadata**|Read|\n\n5. Under _Subscribe to events_, tick _Check runs_.\n6. Click _Create GitHub App_.\n7. If the creation was successful, you'll see an overview of your app. Copy the **App ID** as you'll need it for setting up the script.\n8. Scroll to the bottom of the page to generate a private key. Save the file as `pk.pem`, as you'll need it for setting up the script.\n\n## 2: Setting up the server\n\nThe server will run on port 443, using a simple Python 3 Flask server.\n\n1. Install all dependencies by running the following command:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n2. To create a locally signed SSL certificate, run the followingin the same folder as `server.py`:\n   ```bash\n   openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365\n   ```\n\n3. Copy `pk.pem` (see 'Creating a GitHub app' section) to the same folder as `server.py`.\n4. Update `example.py` to set the correct **App ID**. If you're using GitHub Enterprise, also update the `base_api` parameter.\n\n## 3: Running the server\n\nRun the server as follows:\n\n```\nGITHUB_WEBHOOK_SECRET={{your_secret_here}} sudo -E python3 server.py\n```\n\nMake sure you replace `{{your_secret_here}}` with your webhook secret set in GitHub (see 'Creating a GitHub app' section). You might want to consider changing port 443 to something else so that `server.py` doesn't have to run using sudo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwietze%2Fgithub-checks-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwietze%2Fgithub-checks-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwietze%2Fgithub-checks-api/lists"}