cli tool for generating metadata and assessment report for [BeSLighthouse](https://github.com/Be-Secure/BeSLighthouse).
Project description
Be-Secure Developer Toolkit (bes-dev-kit)
bes-dev-kit is a cli tool for generating metadata and assessment report for BeSLighthouse.
Installation
$ python3 -m pip install besecure-developer-toolkit
Pre-requisites
- Poetry
- Python 3.x
- pip
- Github personal access token
Setting env variables
Note: Should be done before testing/running
-
Creating a json file in your user home dir under the name
bes-dev-kit.json
. -
Copy the below contents and paste it inside the file.
{ "GITHUB_ORG": "Be-Secure", "OSSPOI_DIR": "<complete_path_to>/besecure-osspoi-datastore", "ASSESSMENT_DIR": "<complete_path_to>/besecure-assessment-datastore", "GITHUB_AUTH_TOKEN": "<token>" }
-
Update
OSSPOI_DIR
andASSESSMENT_DIR
with complete path to yourbesecure-assessment-datastore
andbesecure-osspoi-datastore
dirs. -
Add your github personal access token
Setting up locally
- Install poetry. Use the link to install Poetry.
- Clone the repo.
- Move into the cloned directory.
- Create a new virtual env using Poetry -
$ poetry shell
- Run the command to install the tool-
$ poetry install
- Check installation -
$ bes-dev-kit --help
Usage
Generate Metadata
Command helps to generate metadata such as OSSP-master file data and version details file.
$ bes-dev-kit generate metadata
For more options use --help
at end.
Generate Reports
$ bes-dev-kit generate report <report name>
<report name> - scorecard, codeql, criticality_score
For more options use --help
at end.
Note: All three reports can be generated at once by passing all report names - $ bes-dev-kit generate report scorecard criticality_score codeql
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for besecure_developer_toolkit-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98b7112ecd39dd31b5e26da7d3860f99555d43648ce97fc71c50e0dc122736e1 |
|
MD5 | 86e2da2e0ede0d7732772ec73302e3a9 |
|
BLAKE2b-256 | 52d3393b4eccb76ef34d968a89601ac6421fe75512c2195eec291982d28e008a |
Hashes for besecure_developer_toolkit-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 149658bda6dead69099563b9eb135908c5e13a05cb3b059dfb81e6281c837e14 |
|
MD5 | e530ffdd66c61beda64c5dfc19be77a0 |
|
BLAKE2b-256 | b5c7fb8135c0e46ca293c7f42d18f568d371dc95dbd761e194dcd7e3d363603a |