pbom
Paper Bill of Materials (PBOM) - Generate a paper bill of materials from the software of a paper
Science Score: 44.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
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary
Repository
Paper Bill of Materials (PBOM) - Generate a paper bill of materials from the software of a paper
Basic Info
- Host: GitHub
- Owner: andrew
- License: agpl-3.0
- Language: Ruby
- Default Branch: main
- Homepage: https://rubygems.org/gems/pbom
- Size: 51.8 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 4
- Releases: 0
Metadata Files
readme.md
PBOM
Paper Bill of Materials (PBOM) is a tool to generate a bill of materials for an academic paper. It uses syft to generate an SBOM from a directory of code, git repository or docker image. It then uses the SBOM to generate a bill of materials for the paper. The bill of materials is a list of all the software dependencies used in the paper, including the version of the software and the license.
Installation
syft is required to generate the SBOM. Install syft using the following command:
bash
curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
or alternative options listed in the syft installation guide
Install pbom using the following command:
bash
gem install pbom
Usage
bash
pbom generate --input /path/to/code --output /path/to/output
Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/andrew/pbom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
Code of Conduct
Everyone interacting in the Pbom project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
License
AGPL-3.0
Owner
- Name: Andrew Nesbitt
- Login: andrew
- Kind: user
- Location: Bristol, UK
- Company: @ecosyste-ms and @octobox
- Website: https://nesbitt.io
- Twitter: teabass
- Repositories: 357
- Profile: https://github.com/andrew
Working on mapping the world of open source software @ecosyste-ms and empowering developers with @octobox
Citation (CITATION.cff)
cff-version: 1.2.0
title: 'PBOM'
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Andrew
family-names: Nesbitt
email: andrew@ecosyste.ms
orcid: 'https://orcid.org/0009-0007-2710-1118'
repository-code: 'https://github.com/andrew/PBOM'
abstract: >-
"Paper Bill of Materials (PBOM) - Generate a paper bill of materials from the software of a paper "
keywords:
- open source
- package management
- software
license: AGPL-3.0
GitHub Events
Total
- Issues event: 11
- Issue comment event: 8
- Push event: 10
- Pull request review event: 1
- Pull request event: 2
- Create event: 4
Last Year
- Issues event: 11
- Issue comment event: 8
- Push event: 10
- Pull request review event: 1
- Pull request event: 2
- Create event: 4
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Andrew Nesbitt | a****z@g****m | 27 |
| Richard Littauer | r****r@g****m | 2 |
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 8
- Total pull requests: 2
- Average time to close issues: about 3 hours
- Average time to close pull requests: 18 minutes
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 0.88
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 8
- Pull requests: 1
- Average time to close issues: about 3 hours
- Average time to close pull requests: 4 minutes
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 0.88
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- RichardLitt (7)
- andrew (1)
Pull Request Authors
- RichardLitt (4)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- rubygems 1,007 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
- Total maintainers: 1
rubygems.org: pbom
Paper Bill of Materials (PBOM) - Generate a paper bill of materials from the software of a paper
- Homepage: https://github.com/andrew/PBOM
- Documentation: http://www.rubydoc.info/gems/pbom/
- License: agpl-3.0
-
Latest release: 0.1.3
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- ruby/setup-ruby v1 composite
- minitest ~> 5.16
- rake ~> 13.0
- bundler 2.5.12
- minitest 5.23.1
- packageurl-ruby 0.1.0
- pbom 0.1.0
- rake 13.2.1
- packageurl-ruby >= 0