| Name | lbom JSON |
| Version |
0.5
JSON |
| download |
| home_page | None |
| Summary | A powerful tool filling licenses to CycloneDX files |
| upload_time | 2024-07-02 18:30:39 |
| maintainer | None |
| docs_url | None |
| author | kaptain-ops |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 https://github.com/kaptain-ops Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cyclonedx
cdxgen
clearlydefined
license
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# License for boms
Lbom is a powerful tool designed to fill license information for components in CycloneDX files. It automatically adds missing licenses to components, ensuring comprehensive license tracking for your software projects.
## Usage
```
lbom [-h] --input_file INPUT_FILE [--output_file OUTPUT_FILE] [--notice_file NOTICE_FILE] [--format FORMAT] [--harvest] [--ignore_with_str IGNORE_WITH_STR]
Options
-h, --help: Show the help message and exit.
--input_file INPUT_FILE: Path of the input bom file.
--output_file OUTPUT_FILE: Output file path. If not provided, stdout is used.
--notice_file NOTICE_FILE: If provided, Lbom will generate a notices file and output its contents to the specified notice file path.
--format FORMAT: Specify the format of the CycloneDX file (version 1.4 or 1.5).
--harvest: If components exist in the bom without license information available, Lbom will make a request to ClearlyDefined to queue a scan of the library.
--ignore_with_str IGNORE_WITH_STR: Do not fetch license information for components containing specific keywords, separated by commas. Example: company_name,awesome-company-pgk-name
```
## Supported Package Managers and License Information Sources
Lbom supports the following package managers and retrieves license information from the listed sources:
npm: npmjs
maven: mavencentral
git: github
nuget: nuget
pypi: pypi
gem: rubygems
pod: cocoapods
crate: cratesio
debsrc: debian
deb: debian
composer: packagist
go: golang
## Installation
Lbom can be easily installed using pip:
```
pip install lbom
```
## Example
Here's an example of how you can use Lbom to fill license information in a CycloneDX file:
```
# Bom is generated owasp cdxgen
cd project_dir/
cdxgen .
lbom --input_file bom.json --output_file bom_with_licenses.json --notice_file bom_notices.txt
```
### Output
If output file is not specified, bom will be printed to stdout and errors to stderr.
This command will fill missing license information in bom.json and save the result to bom_with_licenses.json. Additionally, it will queue scans for components with missing license information.
## Contribution
If you'd like to contribute to Lbom, feel free to submit pull requests or open issues on GitHub.
## License
Lbom is licensed under the MIT License. See the LICENSE file for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "lbom",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "CycloneDX, cdxgen, clearlydefined, license",
"author": "kaptain-ops",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a9/9d/6c44e055a5348a30a86ee479819fb7f82762c3aca43d62975469f3f64ebe/lbom-0.5.tar.gz",
"platform": null,
"description": "# License for boms\n\nLbom is a powerful tool designed to fill license information for components in CycloneDX files. It automatically adds missing licenses to components, ensuring comprehensive license tracking for your software projects.\n\n## Usage\n\n```\nlbom [-h] --input_file INPUT_FILE [--output_file OUTPUT_FILE] [--notice_file NOTICE_FILE] [--format FORMAT] [--harvest] [--ignore_with_str IGNORE_WITH_STR]\n\nOptions\n\n -h, --help: Show the help message and exit.\n --input_file INPUT_FILE: Path of the input bom file.\n --output_file OUTPUT_FILE: Output file path. If not provided, stdout is used.\n --notice_file NOTICE_FILE: If provided, Lbom will generate a notices file and output its contents to the specified notice file path.\n --format FORMAT: Specify the format of the CycloneDX file (version 1.4 or 1.5).\n --harvest: If components exist in the bom without license information available, Lbom will make a request to ClearlyDefined to queue a scan of the library.\n --ignore_with_str IGNORE_WITH_STR: Do not fetch license information for components containing specific keywords, separated by commas. Example: company_name,awesome-company-pgk-name\n```\n## Supported Package Managers and License Information Sources\nLbom supports the following package managers and retrieves license information from the listed sources: \n\n npm: npmjs\n maven: mavencentral\n git: github\n nuget: nuget\n pypi: pypi\n gem: rubygems\n pod: cocoapods\n crate: cratesio\n debsrc: debian\n deb: debian\n composer: packagist\n go: golang\n\n## Installation\n\nLbom can be easily installed using pip:\n\n```\npip install lbom\n\n```\n\n## Example\n\nHere's an example of how you can use Lbom to fill license information in a CycloneDX file:\n\n```\n# Bom is generated owasp cdxgen\n\ncd project_dir/\ncdxgen .\nlbom --input_file bom.json --output_file bom_with_licenses.json --notice_file bom_notices.txt\n\n```\n\n### Output\n\nIf output file is not specified, bom will be printed to stdout and errors to stderr.\n\nThis command will fill missing license information in bom.json and save the result to bom_with_licenses.json. Additionally, it will queue scans for components with missing license information.\n\n## Contribution\nIf you'd like to contribute to Lbom, feel free to submit pull requests or open issues on GitHub.\n\n## License\n\nLbom is licensed under the MIT License. See the LICENSE file for more information.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 https://github.com/kaptain-ops Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A powerful tool filling licenses to CycloneDX files",
"version": "0.5",
"project_urls": {
"Homepage": "https://github.com/kaptain-ops/lbom"
},
"split_keywords": [
"cyclonedx",
" cdxgen",
" clearlydefined",
" license"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1974f072cf02f13d2c389f8910db271430ce3aeb3b178eeecd723cb6b16dcbd4",
"md5": "d9b4e0c7db9fd32e132f292ba522d03f",
"sha256": "6ed65db3aa1e27e8d74d80ace416a38ed16fcb221cb47504f36b058c9098c82d"
},
"downloads": -1,
"filename": "lbom-0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d9b4e0c7db9fd32e132f292ba522d03f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10430,
"upload_time": "2024-07-02T18:30:34",
"upload_time_iso_8601": "2024-07-02T18:30:34.409702Z",
"url": "https://files.pythonhosted.org/packages/19/74/f072cf02f13d2c389f8910db271430ce3aeb3b178eeecd723cb6b16dcbd4/lbom-0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a99d6c44e055a5348a30a86ee479819fb7f82762c3aca43d62975469f3f64ebe",
"md5": "ef017d8a1de9fb16485f9c2d069df871",
"sha256": "d3edb6596629061997f83fc7d0dd25047bf031b6a613ce3e53ae800a25e05e24"
},
"downloads": -1,
"filename": "lbom-0.5.tar.gz",
"has_sig": false,
"md5_digest": "ef017d8a1de9fb16485f9c2d069df871",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8974,
"upload_time": "2024-07-02T18:30:39",
"upload_time_iso_8601": "2024-07-02T18:30:39.060730Z",
"url": "https://files.pythonhosted.org/packages/a9/9d/6c44e055a5348a30a86ee479819fb7f82762c3aca43d62975469f3f64ebe/lbom-0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-02 18:30:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kaptain-ops",
"github_project": "lbom",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "lbom"
}
