prime-pipeline
An example pipeline that computes metrics of a repository
Science Score: 72.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
✓Institutional organization owner
Organization softwaresystemslaboratory has institutional domain (ssl.cs.luc.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary
Repository
An example pipeline that computes metrics of a repository
Basic Info
Statistics
- Stars: 0
- Watchers: 0
- Forks: 2
- Open Issues: 1
- Releases: 7
Metadata Files
README.md
PRIME Pipeline
An example pipeline that computes metrics of a repository
Table of Contents
About
The Software Systems Laboratory (SSL) PRIME Pipeline Project is an example pipeline that computes metrics of a repository.
The pipeline only calculates metrics for the HEAD branch of a repository.
Licensing
This project is licensed under the BSD-3-Clause. See the LICENSE for more information.
Tooling
To maximize the utility of this project the following software packages are required:
Operating System
All 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.
It 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.
Shell Software
Required Shell Software
gitparallelwgetrclonetmuxpython3.10
Python Software
All listed Python software assumes that you have downloaded and installed Python 3.10 or greater.
clime-metrics
You can install the Python software with this one-liner:
pip install --upgrade pip clime-metrics or ./setup.bash
How To Use
Setting up the Pipeline
Run the following one liner to setup the pipeline:
wget -qO- https://raw.githubusercontent.com/SoftwareSystemsLaboratory/clime-pipeline/main/setup.bash | bash
Executing the Pipeline
pipeline.bash contains the code to start the pipeline.
It takes a GitHub Personal Access Token and a file containing a list of Github Repository URLs as positional arguements.
For an example GitHub Repository URL file, see githubRepositories.txt.
./pipeline.bash $GH_TOKEN githubRepositories.txt
Where $GH_TOKEN is a GitHub Personal Access Token or shell variable referencing it.
githubRepositories.txt can be replaced with any file containing GitHub Repository URLs.
NOTE: The name of this text file will be used to create a folder containing all of the repositories analyzed and their analysis files.
Google Drive Upload
This pipeline is configured to upload results to a Google Drive folder via rclone.
If you don't want to do this, comment out or change the last lines in the runner.bash file.
Owner
- Name: Software and Systems Laboratory
- Login: SoftwareSystemsLaboratory
- Kind: organization
- Email: ssl@cs.luc.edu
- Location: Loyola University Chicago
- Website: https://ssl.cs.luc.edu/
- Repositories: 20
- Profile: https://github.com/SoftwareSystemsLaboratory
Fostering innovation via experimentation and collaboration with an emphasis on openness.
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - given-names: George family-names: Thiruvathukal email: gkt@cs.luc.edu affiliation: Loyola University Chicago orcid: 'https://orcid.org/0000-0002-0452-5571' - given-names: Jacob family-names: Palmer email: jpalmer3@luc.edu affiliation: Loyola University Chicago orcid: 'https://orcid.org/0000-0003-4586-5369' - given-names: Nicholas family-names: Synovic email: nsynovic@luc.edu affiliation: Loyola University Chicago orcid: 'https://orcid.org/0000-0003-0413-4594' title: "SoftwareSystemsLaboratory/clime-pipeline" version: 0.2 doi: 10.5281/zenodo.6480608 date-released: 2022-02-07 url: "https://github.com/SoftwareSystemsLaboratory/clime-pipeline"
GitHub Events
Total
Last Year
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Nicholas M. Synovic | n****c@g****m | 85 |
| Ethan Stoneman | e****n@l****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 1
- Total pull requests: 12
- Average time to close issues: N/A
- Average time to close pull requests: 1 day
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- NicholasSynovic (1)
Pull Request Authors
- NicholasSynovic (11)
- estoneman (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- softprops/action-gh-release v1 composite