{"id":13529686,"url":"https://github.com/YouEclipse/waka-box-go","last_synced_at":"2025-04-01T17:30:37.786Z","repository":{"id":44462884,"uuid":"269634679","full_name":"YouEclipse/waka-box-go","owner":"YouEclipse","description":"📊 Update profile README / pinned gist to contain your weekly WakaTime stats.  This is a Golang implementation, see the original version https://github.com/matchai/waka-box.   将你的 WakaTime 每周语言使用统计显示在 profile README / pined gist。","archived":false,"fork":false,"pushed_at":"2024-01-31T11:28:47.000Z","size":47,"stargazers_count":169,"open_issues_count":3,"forks_count":145,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-02T16:35:21.303Z","etag":null,"topics":["pinned-gist","profile","profile-readme","wakatime","wakatime-api","weekly-wakatime-stats"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YouEclipse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-05T12:51:46.000Z","updated_at":"2024-09-06T15:43:51.000Z","dependencies_parsed_at":"2024-04-12T20:55:14.773Z","dependency_job_id":null,"html_url":"https://github.com/YouEclipse/waka-box-go","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YouEclipse%2Fwaka-box-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YouEclipse%2Fwaka-box-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YouEclipse%2Fwaka-box-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YouEclipse%2Fwaka-box-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YouEclipse","download_url":"https://codeload.github.com/YouEclipse/waka-box-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246680166,"owners_count":20816642,"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","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":["pinned-gist","profile","profile-readme","wakatime","wakatime-api","weekly-wakatime-stats"],"created_at":"2024-08-01T07:00:38.532Z","updated_at":"2025-04-01T17:30:37.507Z","avatar_url":"https://github.com/YouEclipse.png","language":"Go","funding_links":[],"categories":["Go","External Services"],"sub_categories":[],"readme":"#\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"400\" src=\"https://user-images.githubusercontent.com/8252317/83985147-9afb2800-a96a-11ea-9841-eec3a1f61d75.png\"\u003e\n  \u003ch3 align=\"center\"\u003ewaka-box-go\u003c/h3\u003e\n  \u003cp align=\"center\"\u003e📊 Update  pinned gist / profile README  to contain your weekly WakaTime stats. \u003c/p\u003e\n  \u003cp align=\"center\"\u003e  A Golang implementation, see the original version  \u003ca href=\"https://github.com/matchai/waka-box\"\u003ewaka-box\u003c/a\u003e\n   \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/YouEclipse/waka-box-go/workflows/Update%20gist%20with%20WakaTime%20stats/badge.svg?branch=master\"\u003e\u003cimg src=\"https://github.com/YouEclipse/waka-box-go/workflows/Update%20gist%20with%20WakaTime%20stats/badge.svg?branch=master\" alt=\"Update gist with WakaTime stats\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n---\n\nEnglish | [简体中文](./README_zh.md)\n\n\u003e 📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists\n\n## 💻 Setup\n\n### 🎒 Prep work\n\n\u003e if only want's to update a markdown,like profile README,skip step 1 and step 2.\n\n1. Create a new public GitHub Gist with name `📊 Weekly development breakdown` (https://gist.github.com/)\n1. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new)\n1. Create a WakaTime account (https://wakatime.com/signup)\n1. In your WakaTime profile settings (https://wakatime.com/settings/profile) ensure `Display coding activity publicly` and `Display languages, editors, operating systems publicly` are checked.\n1. In your account settings, copy the existing WakaTime API Key (https://wakatime.com/settings/api-key)\n1. For updating a markdown file，add comments to the place where you want to update in the markdown file.\n   ```markdown\n    \u003c!-- waka-box start --\u003e\n    \u003c!-- waka-box end --\u003e\n   ```\n\n### 🚀 Project setup\n\n1. Fork this repo\n   \n\n2. Edit the [environment variable](https://github.com/YouEclipse/waka-box-go/actions/runs/126970182/workflow#L17-L19) in `.github/workflows/schedule.yml`:\n\n   \u003e For updating github profile README,you can follow [waka-box.yml](https://github.com/YouEclipse/YouEclipse/blob/master/.github/workflows/waka-box.yml) in [YouEclipse](https://github.com/YouEclipse/YouEclipse) to create a Action in your README repo.Remember it's unsafe to use token with **`repo`** scope for updating the repo, waka-box update the profile repo using git command in Github Action instead of using github API.\n   \n   \u003e DO NOT CHANGE THE WAKATIME_API_KEY or GH_TOKEN VALUES IN THIS FILE, USE THE REPO SECRETS SET BELOW. FAILURE TO DO THIS WILL MAKE YOUR WAKATIME API KEY PUBLIC AND CAN POTENTIALLY EXPOSE SENSITIVE INFORMATION.\n\n   - **UPDATE_OPTION:** Default is `GIST`.For only update a markdown file ,set to`MARKDOWN`,and ignore environment variables with prefix **GIST\\_** below.Set to `GIST_AND_MARKDOWN` updates both the gist and the markdown file.\n   - **MARKDOWN_FILE:** The filename for the markdown file.\n\n   - **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/YouEclipse/`**`9bc7025496e478f439b9cd43eba989a4`**.\n\n     **the following are optional, thanks [@AarynSmith](https://github.com/AarynSmith) for PR([#11](https://github.com/YouEclipse/waka-box-go/pull/11))**\n\n   - **GIST_BARSTYLE:** Background of the progress bar. Default is \"SOLIDLT\" other options include \"SOLIDMD\", \"SOLIDDK\" for medium and dark backgrounds, \"EMPTY\" for blank background, and \"UNDERSCORE\" for a line along the bottom.\n   - **GIST_BARLENGTH:** Length of the progress bar. Default is 21. Set to -1 to auto size the bar.\n   - **GIST_TIMESTYLE** Abbreviate the time text. Default is \"LONG\" ( \"# hrs # mins\" ). \"SHORT\" updates the text to \"#h#m\".\n\n3. Go to the repo **Settings \u003e Secrets**\n4. Add the following environment variables:\n   - **GH_TOKEN:** The GitHub token generated above.\n   - **WAKATIME_API_KEY:** The API key for your WakaTime account.\n\n## 🕵️ How it works\n\n- Get stats from WakaTime API\n- Update Gist with Github API\n- Use Github Actions for updating Gist\n\n## 📄 License\n\nThis project is licensed under [Apache-2.0](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYouEclipse%2Fwaka-box-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FYouEclipse%2Fwaka-box-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYouEclipse%2Fwaka-box-go/lists"}