{"id":18458574,"url":"https://github.com/softwaresystemslaboratory/prime-pipeline","last_synced_at":"2025-10-14T05:16:50.472Z","repository":{"id":41961182,"uuid":"455386614","full_name":"SoftwareSystemsLaboratory/prime-pipeline","owner":"SoftwareSystemsLaboratory","description":"An example pipeline that computes metrics of a repository","archived":false,"fork":false,"pushed_at":"2022-10-06T18:53:05.000Z","size":54,"stargazers_count":0,"open_issues_count":1,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-05T01:14:49.377Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SoftwareSystemsLaboratory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":".zenodo.json"}},"created_at":"2022-02-04T01:26:45.000Z","updated_at":"2022-10-06T18:52:08.000Z","dependencies_parsed_at":"2023-01-19T14:03:15.784Z","dependency_job_id":null,"html_url":"https://github.com/SoftwareSystemsLaboratory/prime-pipeline","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/SoftwareSystemsLaboratory/prime-pipeline","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftwareSystemsLaboratory%2Fprime-pipeline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftwareSystemsLaboratory%2Fprime-pipeline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftwareSystemsLaboratory%2Fprime-pipeline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftwareSystemsLaboratory%2Fprime-pipeline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SoftwareSystemsLaboratory","download_url":"https://codeload.github.com/SoftwareSystemsLaboratory/prime-pipeline/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftwareSystemsLaboratory%2Fprime-pipeline/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018015,"owners_count":26086237,"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-10-14T02:00:06.444Z","response_time":60,"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":[],"created_at":"2024-11-06T08:19:08.450Z","updated_at":"2025-10-14T05:16:50.457Z","avatar_url":"https://github.com/SoftwareSystemsLaboratory.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PRIME Pipeline\n\n[![DOI](https://zenodo.org/badge/455386614.svg)](https://zenodo.org/badge/latestdoi/455386614)\n[![Release Project](https://github.com/SoftwareSystemsLaboratory/clime-pipeline/actions/workflows/release.yml/badge.svg)](https://github.com/SoftwareSystemsLaboratory/clime-pipeline/actions/workflows/release.yml)\n\n\u003e An example pipeline that computes metrics of a repository\n\n## Table of Contents\n\n- [PRIME Pipeline](#clime-pipeline)\n  - [Table of Contents](#table-of-contents)\n  - [About](#about)\n    - [Licensing](#licensing)\n  - [Tooling](#tooling)\n    - [Operating System](#operating-system)\n    - [Shell Software](#shell-software)\n      - [Required Shell Software](#required-shell-software)\n    - [Python Software](#python-software)\n  - [How To Use](#how-to-use)\n    - [Setting up the Pipeline](#setting-up-the-pipeline)\n    - [Executing the Pipeline](#executing-the-pipeline)\n    - [Google Drive Upload](#google-drive-upload)\n\n## About\n\nThe Software Systems Laboratory (SSL) PRIME Pipeline Project is an example pipeline that computes metrics of a repository.\n\nThe pipeline *only* calculates metrics for the `HEAD` branch of a repository.\n\n### Licensing\n\nThis project is licensed under the BSD-3-Clause. See the [LICENSE](LICENSE) for more information.\n\n## Tooling\n\nTo maximize the utility of this project the following software packages are **required**:\n\n### Operating System\n\nAll tools developed for the greater SSL Metrics project **target** Mac OS and Linux. SSL Metrics software is not supported or recommended to run on Windows *but can be modified to do so at your own risk*.\n\nIt is recomendded to run on Mac OS or Linux. However, if you are on a Windows machine, you can use WSL to run this software as well.\n\n### Shell Software\n\n#### Required Shell Software\n\n- `git`\n- `parallel`\n- `wget`\n- `rclone`\n- `tmux`\n- `python3.10`\n\n### Python Software\n\nAll listed Python software assumes that you have downloaded and installed **Python 3.10** or greater.\n\n- `clime-metrics`\n\nYou can install the Python software with this one-liner:\n\n`pip install --upgrade pip clime-metrics` or `./setup.bash`\n\n## How To Use\n\n### Setting up the Pipeline\n\nRun the following one liner to setup the pipeline:\n\n- `wget -qO- https://raw.githubusercontent.com/SoftwareSystemsLaboratory/clime-pipeline/main/setup.bash | bash`\n\n### Executing the Pipeline\n\n`pipeline.bash` contains the code to start the pipeline.\nIt takes a GitHub Personal Access Token and a file containing a list of Github Repository URLs as positional arguements.\n\nFor an example GitHub Repository URL file, see [githubRepositories.txt](githubRepositories.txt).\n\n- `./pipeline.bash $GH_TOKEN githubRepositories.txt`\n\nWhere `$GH_TOKEN` is a GitHub Personal Access Token or shell variable referencing it.\n\n`githubRepositories.txt` can be replaced with any file containing GitHub Repository URLs.\n\n**NOTE:** The name of this text file will be used to create a folder containing all of the repositories analyzed and their analysis files.\n\n### Google Drive Upload\n\nThis pipeline is configured to upload results to a Google Drive folder via `rclone`.\nIf you don't want to do this, comment out or change the last lines in the `runner.bash` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftwaresystemslaboratory%2Fprime-pipeline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftwaresystemslaboratory%2Fprime-pipeline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftwaresystemslaboratory%2Fprime-pipeline/lists"}