bdnotice 0.1.0

Generate Notice file from Blackduck in JSON, TEXT or HTML format

BDNOTICE

Generate Notice file from Blackduck in JSON, TEXT or HTML format

Description

This is intended for generating Notice file from Blackduck in JSON, TEXT or HTML format

Getting Started

Dependencies

• Blackduck
• importlib-resources

Installing

• pip install bdnotice

Executing program

• How to run the program

<!-- on the folder it is running place this blackduck config file for blackduck library-->
.restconfig.json
{
    <!-- make sure Blackduck_url should not end with slash -->
  "baseurl": "Blackduck_url",
  "api_token": "API_KEY",
  "insecure": true,
  "debug": false
}

pip install bdnotice
ex:
bdnotice PJ PV -f C:\DIR\Blackduck_report -r HTML -c
bdnotice PJ PV -f C:\DIR\Blackduck_report -r TEXT -c

Help

Any advise for common problems or issues.

>bdnotice -h
usage: A program to generate the notices file for a given project-version
       [-h] [-f FILE_NAME_BASE] [-r {JSON,TEXT,HTML}] [-c] project_name version_name

positional arguments:
  project_name
  version_name

options:
  -h, --help            show this help message and exit
  -f FILE_NAME_BASE, --file_name_base FILE_NAME_BASE
                        Base file name to write the report data into. If the report
                        format is TEXT a .zip file will be created, otherwise a .json
                        file
  -r {JSON,TEXT,HTML}, --report_format {JSON,TEXT,HTML}
                        Report format - choices are TEXT, JSON or HTML
  -c, --include_copyright_info
                        Set this option to have additional copyright information from
                        the Black Duck KB included in the notices file report.

Authors

Dinesh Ravi

Version History

• 0.1.0
  • Initial Release

License

This project is licensed under the MIT License - see the MIT file for details

Acknowledgments

• Blackduck
• importlib-resources