{"id":17223045,"url":"https://github.com/marksteve/blossom","last_synced_at":"2025-03-25T16:22:48.836Z","repository":{"id":138469075,"uuid":"174249258","full_name":"marksteve/blossom","owner":"marksteve","description":"Get open-source software (OSS) metrics for your Github project","archived":false,"fork":false,"pushed_at":"2019-03-04T00:45:03.000Z","size":48,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-30T14:26:14.842Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marksteve.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-03-07T01:34:19.000Z","updated_at":"2023-06-04T07:14:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"04bc8fb3-7bdf-441d-adf8-660a4bd9ef2e","html_url":"https://github.com/marksteve/blossom","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/marksteve%2Fblossom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksteve%2Fblossom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksteve%2Fblossom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksteve%2Fblossom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marksteve","download_url":"https://codeload.github.com/marksteve/blossom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245496813,"owners_count":20624898,"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":[],"created_at":"2024-10-15T04:07:14.401Z","updated_at":"2025-03-25T16:22:48.807Z","avatar_url":"https://github.com/marksteve.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# blossom\n\n[![GoDoc](https://godoc.org/github.com/ljvmiranda921/blossom?status.svg)](https://godoc.org/github.com/ljvmiranda921/blossom)\n\n**blossom** is a **b**undle of **l**ightweight **o**pen-**s**ource **so**ftware **m**etrics. \nIt is a tool that enables you to fetch [software metrics](https://opensource.guide/metrics/) \nfrom any of your organization's repository in Github.\n\n## Setup\n\nThis application requires [go1.11](https://golang.org/doc/go1.11) in order to\nwork. First, clone the repository and enter it: \n\n```s\n$ git clone git@github.com:ljvmiranda921/blossom.git\n$ cd blossom\n```\n\nThen get the dependencies and build the project:\n\n```s\n$ go get\n$ go build .\n```\n\nOptionally, you can also install `blossom` in your system:\n\n```s\n$ go install\n```\n\n## Usage\n\n### Authentication\n\nBecause we rely on the [Github v4 GraphQL\nAPI](https://developer.github.com/v4/), an [API\ntoken](https://github.blog/2013-05-16-personal-api-tokens/) is required. We\nrecommend creating a `.env` file with the `GITHUB_TOKEN` variable:\n\n```s\n# .env\nGITHUB_TOKEN=\u003cyour API token here\u003e\n```\n\nAll authentication is handled by `pkg/auth`.\n\n### Getting open-source software metrics\n\nMost of the metrics here were based from [CHAOSS's open-source software\nmetrics](https://github.com/chaoss/metrics). To obtain them for a particular\nrepository, simply run the following command:\n\n```s\n$ blossom report \u003cowner\u003e/\u003crepository\u003e\n```\n\nFor example,\n\n```s\n$ blossom report ljvmiranda921/blossom\n```\n\nSo far, I am still updating the metrics that we have. If you would like to help\nout, then I'd definitely appreciate it!\n\n## Contributing\n\nSimply fork this repository and [make a Pull\nRequest](https://help.github.com/en/articles/creating-a-pull-request)! I'm\nopen to any kind of contribution, but I'd definitely appreciate:\n\n- Implementation of some open-source software metrics\n- Proposal for new metrics\n- Documentation\n- Testing\n\nAlso, we have a\n[CONTRIBUTING.md](https://github.com/ljvmiranda921/blossom/blob/master/CONTRIBUTING.md)\nand a [Code of\nConduct](https://github.com/ljvmiranda921/blossom/blob/master/CODE_OF_CONDUCT.md),\nso please check that one out!\n\n## FAQ\n\n- **Why make this if there's already CHAOSS?** The CHAOSS toolset is really\n    good and comprehensive, but I want something that's more lightweight and\n    \"atomic.\" I want to immediately get software metrics without setting up my\n    own webserver etc., so this fits into my use-case.\n- **Can I already use this in my organization?** This is still experimental and\n     not yet production-ready. I also don't know (yet) how this can be\n     deployed. If you've successfully used this in any of your projects then\n     feel free to ping me!\n- **Your Golang skills needs improvement** I know, I'm still learning Go so\n    please bear with me. If there are any code smells, please don't hesitate to\n     make a PR!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksteve%2Fblossom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarksteve%2Fblossom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksteve%2Fblossom/lists"}