@trustify-da/trustify-da-javascript-client 0.2.4-ea-1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,482 @@
+# Exhort JavaScript API<br/>![latest-no-snapshot][0] ![latest-snapshot][1]
+
+* Looking for the OpenAPI Spec? Try [Exhort API Spec](https://github.com/trustify-da/trustify-da-api-model)
+* Looking for our Java API? Try [Exhort Java API](https://github.com/guacsec/exhort-java-api).
+* Looking for our Backend implementation? Try [Exhort](https://github.com/guacsec/exhort).
+
+<h3>Usage</h3>
+<p>
+
+<ul>
+<li>
+Use as ESM Module from an ESM module
+
+```shell
+npm install @trustify-da/trustify-da-javascript-client
+```
+
+```javascript
+import exhort from '@trustify-da/trustify-da-javascript-client'
+import fs from 'node:fs'
+
+// Get stack analysis in JSON format
+let stackAnalysis = await exhort.stackAnalysis('/path/to/pom.xml')
+// Get stack analysis in HTML format (string)
+let stackAnalysisHtml = await exhort.stackAnalysis('/path/to/pom.xml', true)
+// Get component analysis in JSON format
+let componentAnalysis = await exhort.componentAnalysis('/path/to/pom.xml')
+```
+</li>
+</ul>
+<ul>
+<li>
+Use as ESM Module from Common-JS module
+
+```shell
+npm install @trustify-da/trustify-da-javascript-client
+```
+
+```javascript
+async function loadExhort()
+{
+// dynamic import is the only way to import ESM module into commonJS module
+  const { default: exhort } = await import('@trustify-da/trustify-da-javascript-client');
+  return exhort
+}
+const runExhort = (manifestPath) => {
+  return new Promise(async ( resolve, reject) => {
+    try {
+      let stackAnalysisReport = await (await loadExhort()).stackAnalysis(manifestPath,false)
+      resolve(stackAnalysisReport)
+
+    } catch (error)
+    {
+      reject(error)
+    }
+  });
+};
+
+runExhort("./path/to/manifest").then(resp => console.log(JSON.stringify(resp,null,4)))
+```
+</li>
+
+<li>
+Use as CLI Script
+<details>
+<summary>Click for help menu</summary>
+
+```shell
+$ npx @trustify-da/trustify-da-javascript-client help
+
+Usage: trustify-da-javascript-client {component|stack}
+
+Commands:
+  trustify-da-javascript-client stack </path/to/manifest> [--html|--summary]               produce stack report for manifest path
+  trustify-da-javascript-client component <path/to/manifest> [--summary]   produce component report for a manifest type and content
+
+Options:
+  --help  Show help                                                    [boolean]
+```
+</details>
+
+```shell
+# get stack analysis in json format
+$ npx @trustify-da/trustify-da-javascript-client stack /path/to/pom.xml
+
+# get stack analysis in json format (summary only)
+$ npx @trustify-da/trustify-da-javascript-client stack /path/to/pom.xml --summary
+
+# get stack analysis in html format format
+$ npx @trustify-da/trustify-da-javascript-client stack /path/to/pom.xml --html
+
+# get component analysis
+$ npx @trustify-da/trustify-da-javascript-client component /path/to/pom.xml
+```
+</li>
+
+<li>
+Use as Global Binary
+
+```shell
+npm install --global @trustify-da/trustify-da-javascript-client
+```
+
+```shell
+# get stack analysis in json format
+$ trustify-da-javascript-client stack /path/to/pom.xml
+
+# get stack analysis in json format (summary only)
+$ trustify-da-javascript-client stack /path/to/pom.xml --summary
+
+# get stack analysis in html format format
+$ trustify-da-javascript-client stack /path/to/pom.xml --html
+
+# get component analysis
+$ trustify-da-javascript-client component /path/to/pom.xml
+```
+</li>
+</ul>
+
+<h3>Supported Ecosystems</h3>
+<ul>
+<li><a href="https://www.java.com/">Java</a> - <a href="https://maven.apache.org/">Maven</a></li>
+<li><a href="https://www.javascript.com/">JavaScript</a> - <a href="https://www.npmjs.com/">Npm</a></li>
+<li><a href="https://www.javascript.com/">JavaScript</a> - <a href="https://pnpm.io/">pnpm</a></li>
+<li><a href="https://www.javascript.com/">JavaScript</a> - <a href="https://classic.yarnpkg.com/">Yarn Classic</a> /  <a href="https://yarnpkg.com/">Yarn Berry</a></li>
+<li><a href="https://go.dev/">Golang</a> - <a href="https://go.dev/blog/using-go-modules/">Go Modules</a></li>
+<li><a href="https://www.python.org/">Python</a> - <a href="https://pypi.org/project/pip/">pip Installer</a></li>
+<li><a href="https://gradle.org/">Gradle (Groovy and Kotlin DSL)</a> - <a href="https://gradle.org/install/">Gradle Installation</a></li>
+</ul>
+
+<h3>Excluding Packages</h3>
+<p>
+Excluding a package from any analysis can be achieved by marking the package for exclusion.
+</p>
+
+<ul>
+<li>
+<em>Java Maven</em> users can add a comment in <em>pom.xml</em>
+
+```xml
+<dependency> <!--exhortignore-->
+  <groupId>...</groupId>
+  <artifactId>...</artifactId>
+  <version>...</version>
+</dependency>
+```
+</li>
+
+</ul>
+<ul>
+<li>
+<em>Javascript</em> users can add a root (key, value) pair with value of list of names (strings) to be ignored (without versions), and key called <b>exhortignore</b> in <em>package.json</em>,  example:
+
+```json
+{
+  "name": "sample",
+  "version": "1.0.0",
+  "description": "",
+  "main": "js",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "dotenv": "^8.2.0",
+    "express": "^4.17.1",
+    "jsonwebtoken": "^8.5.1",
+    "mongoose": "^5.9.18"
+  },
+  "exhortignore": [
+    "jsonwebtoken"
+  ]
+}
+```
+
+<em>Golang</em> users can add in go.mod a comment with //exhortignore next to the package to be ignored, or to "piggyback" on existing comment ( e.g - //indirect) , for example:
+```go
+module github.com/trustify-da/SaaSi/deployer
+
+go 1.19
+
+require (
+        github.com/gin-gonic/gin v1.9.1
+        github.com/google/uuid v1.1.2
+        github.com/jessevdk/go-flags v1.5.0 //exhortignore
+        github.com/kr/pretty v0.3.1
+        gopkg.in/yaml.v2 v2.4.0
+        k8s.io/apimachinery v0.26.1
+        k8s.io/client-go v0.26.1
+)
+
+require (
+        github.com/davecgh/go-spew v1.1.1 // indirect exhortignore
+        github.com/emicklei/go-restful/v3 v3.9.0 // indirect
+        github.com/go-logr/logr v1.2.3 // indirect //exhortignore
+
+)
+```
+
+<em>Python pip</em> users can add in requirements.txt a comment with #exhortignore(or # exhortignore) to the right of the same artifact to be ignored, for example:
+```properties
+anyio==3.6.2
+asgiref==3.4.1
+beautifulsoup4==4.12.2
+certifi==2023.7.22
+chardet==4.0.0
+click==8.0.4 #exhortignore
+contextlib2==21.6.0
+fastapi==0.75.1
+Flask==2.0.3
+h11==0.13.0
+idna==2.10
+immutables==0.19
+importlib-metadata==4.8.3
+itsdangerous==2.0.1
+Jinja2==3.0.3
+MarkupSafe==2.0.1
+pydantic==1.9.2 # exhortignore
+requests==2.25.1
+six==1.16.0
+sniffio==1.2.0
+soupsieve==2.3.2.post1
+starlette==0.17.1
+typing_extensions==4.1.1
+urllib3==1.26.16
+uvicorn==0.17.0
+Werkzeug==2.0.3
+zipp==3.6.0
+
+```
+
+<em>Gradle</em> users can add in build.gradle a comment with //exhortignore next to the package to be ignored:
+```build.gradle
+plugins {
+id 'java'
+}
+
+group = 'groupName'
+version = 'version'
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation "groupId:artifactId:version" // exhortignore
+}
+test {
+    useJUnitPlatform()
+}
+```
+
+All of the 5 above examples are valid for marking a package to be ignored
+</li>
+
+</ul>
+
+<h3>Customization</h3>
+<p>
+There are 2 approaches for customizing <em>Exhort JavaScript API</em>. Whether you're using this API as a
+<em>Global Module</em>, a <em>Remote Script</em>, or an <em>ESM Module</em>, you can use <em>Environment Variables</em>
+for various customization.
+
+However, <em>ESM Module</em> users, can opt for customizing programmatically:
+
+```javascript
+import exhort from '@trustify-da/trustify-da-javascript-client'
+import fs from 'node:fs'
+
+let options = {
+  'TRUSTIFY_DA_MVN_PATH': '/path/to/my/mvn',
+  'TRUSTIFY_DA_NPM_PATH': '/path/to/npm',
+  'TRUSTIFY_DA_PNPM_PATH': '/path/to/pnpm',
+  'TRUSTIFY_DA_GO_PATH': '/path/to/go',
+  //python - python3, pip3 take precedence if python version > 3 installed
+  'TRUSTIFY_DA_PYTHON3_PATH' : '/path/to/python3',
+  'TRUSTIFY_DA_PIP3_PATH' : '/path/to/pip3',
+  'TRUSTIFY_DA_PYTHON_PATH' : '/path/to/python',
+  'TRUSTIFY_DA_PIP_PATH' : '/path/to/pip',
+  'TRUSTIFY_DA_GRADLE_PATH' : '/path/to/gradle',
+  // Configure proxy for all requests
+  'TRUSTIFY_DA_PROXY_URL': 'http://proxy.example.com:8080'
+}
+
+// Get stack analysis in JSON format ( all package managers, pom.xml is as an example here)
+let stackAnalysis = await exhort.stackAnalysis('/path/to/pom.xml', false, options)
+// Get stack analysis in HTML format in string ( all package managers, pom.xml is as an example here)
+let stackAnalysisHtml = await exhort.stackAnalysis('/path/to/pom.xml', true, options)
+
+// Get component analysis in JSON format
+let componentAnalysis = await exhort.componentAnalysis('/path/to/pom.xml', options)
+```
+ **_Environment variables takes precedence._**
+</p>
+
+<h4>Proxy Configuration</h4>
+<p>
+You can configure a proxy for all HTTP/HTTPS requests made by the API. This is useful when your environment requires going through a proxy to access external services.
+
+You can set the proxy URL in two ways:
+
+1. Using environment variable:
+```shell
+export TRUSTIFY_DA_PROXY_URL=http://proxy.example.com:8080
+```
+
+2. Using the options object when calling the API programmatically:
+```javascript
+const options = {
+  'TRUSTIFY_DA_PROXY_URL': 'http://proxy.example.com:8080'
+}
+```
+
+The proxy URL should be in the format: `http://host:port` or `https://host:port`. The API will automatically use the appropriate protocol (HTTP or HTTPS) based on the proxy URL provided.
+</p>
+
+<h4>Customizing Executables</h4>
+<p>
+This project uses each ecosystem's executable for creating dependency trees. These executables are expected to be
+present on the system's PATH environment. If they are not, or perhaps you want to use custom ones. Use can use the
+following keys for setting custom paths for the said executables.
+</p>
+
+<table>
+<tr>
+<th>Ecosystem</th>
+<th>Default</th>
+<th>Executable Key</th>
+</tr>
+<tr>
+<td><a href="https://maven.apache.org/">Maven</a></td>
+<td><em>mvn</em></td>
+<td>TRUSTIFY_DA_MVN_PATH</td>
+</tr>
+<tr>
+<td><a href="https://maven.apache.org/">Maven</a></td>
+<td><em>maven</em></td>
+<td>TRUSTIFY_DA_PREFER_MVNW</td>
+</tr>
+<tr>
+<td><a href="https://www.npmjs.com/">NPM</a></td>
+<td><em>npm</em></td>
+<td>TRUSTIFY_DA_NPM_PATH</td>
+</tr>
+<tr>
+<td><a href="https://pnpm.io/">PNPM</a></td>
+<td><em>pnpm</em></td>
+<td>TRUSTIFY_DA_PNPM_PATH</td>
+</tr>
+<tr>
+<td><a href="https://classic.yarnpkg.com/">Yarn Classic</a> / <a href="https://yarnpkg.com/">Yarn Berry</a></td>
+<td><em>yarn</em></td>
+<td>TRUSTIFY_DA_YARN_PATH</td>
+</tr>
+<tr>
+<td><a href="https://go.dev/blog/using-go-modules/">Go Modules</a></td>
+<td><em>go</em></td>
+<td>TRUSTIFY_DA_GO_PATH</td>
+</tr>
+<tr>
+<td><a href="https://www.python.org/">Python programming language</a></td>
+<td><em>python3</em></td>
+<td>TRUSTIFY_DA_PYTHON3_PATH</td>
+</tr>
+<tr>
+<td><a href="https://pypi.org/project/pip/">Python pip Package Installer</a></td>
+<td><em>pip3</em></td>
+<td>TRUSTIFY_DA_PIP3_PATH</td>
+</tr>
+<tr>
+<td><a href="https://www.python.org/">Python programming language</a></td>
+<td><em>python</em></td>
+<td>TRUSTIFY_DA_PYTHON_PATH</td>
+</tr>
+<tr>
+<td><a href="https://pypi.org/project/pip/">Python pip Package Installer</a></td>
+<td><em>pip</em></td>
+<td>TRUSTIFY_DA_PIP_PATH</td>
+</tr>
+<tr>
+<td><a href="https://gradle.org/">Gradle</a></td>
+<td><em>gradle</em></td>
+<td>TRUSTIFY_DA_GRADLE_PATH</td>
+</tr>
+<tr>
+<td><a href="https://gradle.org/">Gradle</a></td>
+<td><em>gradle</em></td>
+<td>TRUSTIFY_DA_PREFER_GRADLEW</td>
+</tr>
+</table>
+
+#### Match Manifest Versions Feature
+
+##### Background
+
+In Python pip and in golang go modules package managers ( especially in Python pip) , There is a big chance that for a certain manifest and a given package inside it, the client machine environment has different version installed/resolved
+for that package, which can lead to perform the analysis on the installed packages' versions , instead on the declared versions ( in manifests - that is requirements.txt/go.mod ), and this
+can cause a confusion for the user in the client consuming the API and leads to inconsistent output ( in THE manifest there is version X For a given Package `A` , and in the analysis report there is another version for the same package `A` - Y).
+
+##### Usage
+
+To eliminate confusion and improve clarity as discussed above, the following setting was introduced - `MATCH_MANIFEST_VERSIONS`, in the form of environment variable/key in opts ( as usual , environment variable takes precedence )
+for two ecosystems:
+ - Golang - Go Modules
+ - Python - pip
+
+Two possible values for this setting:
+
+1. MATCH_MANIFEST_VERSIONS="false" - means that if installed/resolved versions of packages are different than the ones declared in the manifest, the process will ignore this difference and will continue to analysis with installed/resolved versions ( this is the original logic flow )
+<br>
+
+
+2. MATCH_MANIFEST_VERSIONS="true" - means that before starting the analysis,
+   the api will compare all the versions of packages in manifest against installed/resolved versions on client' environment, in case there is a difference, it will throw an error to the client/user with message containing the first encountered versions mismatch, including package name, and the versions difference, and will suggest to set setting `MATCH_MANIFEST_VERSIONS`="false" to ignore all differences
+
+#### Golang Support
+
+By default, Golang dependency resolution follows the [Minimal Version Selection (MVS) Algorithm](https://go.dev/ref/mod#minimal-version-selection).
+This means that when analyzing a project, only the module versions that would actually be included in the final executable are considered.
+
+For example, if your `go.mod` file declares two modules, `a` and `b`, and both depend on the same package `c` (same major version `v1`) but with different minor versions:
+
+- `namespace/c/v1@v1.1`
+- `namespace/c/v1@v1.2`
+
+Only one of these versions — the minimal version selected by MVS — will be included in the generated SBOM and analysis results.
+This mirrors the behavior of a real Go build, where only one minor version of a given major version can be present in the executable (since Go treats packages with the same name and major version as identical).
+
+The MVS-based resolution is **enabled by default**.
+If you want to disable this behavior and instead include **all transitive module versions** (as listed in `go.mod` dependencies), set the system property or environment variable:
+
+```bash
+TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED=false
+```
+
+#### Python Support
+
+By default, For python support, the api assumes that the package is installed using the pip/pip3 binary on the system PATH, or using the customized
+Binaries passed to environment variables. In any case, If the package is not installed , then an error will be thrown.
+
+There is an experimental feature of installing the requirements.txt on a virtual env(only python3 or later is supported for this feature) - in this case,
+it's important to pass in a path to python3 binary as `TRUSTIFY_DA_PYTHON3_PATH` or instead make sure that python3 is on the system path.
+in such case, You can use that feature by setting environment variable `TRUSTIFY_DA_PYTHON_VIRTUAL_ENV` to true.
+
+##### "Best Efforts Installation"
+Since Python pip packages are very sensitive/picky regarding python version changes( every small range of versions is only tailored for a certain python version), I'm introducing this feature, that
+tries to install all packages in requirements.txt onto created virtual environment while **disregarding** versions declared for packages in requirements.txt.
+This increasing the chances and the probability that the automatic installation will succeed.
+
+###### Usage
+A New setting is introduced - `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS` (as both env variable/key in `options` object)
+1. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="false" - install requirements.txt while respecting declared versions for all packages.
+2. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set setting `MATCH_MANIFEST_VERSIONS` to 'false'.
+
+##### Using `pipdeptree`
+By default, The API algorithm will use native commands of PIP installer as data source to build the dependency tree.
+It's also possible to use the lightweight Python PIP utility [pipdeptree](https://pypi.org/project/pipdeptree/) as data source instead. In order to activate this, you need to set the environment variable/option `TRUSTIFY_DA_PIP_USE_DEP_TREE` to 'true'.
+
+#### Toggle Red Hat Trusted Content recommendations
+Both the HTML-based report and JSON response will by default contain recommendations for migrating to Red Hat-based Trusted Content repositories. This feature can be disabled by setting `TRUSTIFY_DA_RECOMMENDATIONS_ENABLED` to 'false' via environment variables or options.
+
+#### Additional CLI arguments
+For some ecosystems we support passing additional CLI arguments to the underlying tools. The following table outlines the supported ecosystems and the environment variable/option that configures this. Note that the arguments are expected to be in the format of a JSON array.
+
+|Ecosystem|Key            |
+|---------|---------------|
+|Maven    |TRUSTIFY_DA_MVN_ARGS|
+
+
+<!-- Badge links -->
+[0]: https://img.shields.io/github/v/release/guacsec/trustify-da-javascript-client?color=green&label=latest
+[1]: https://img.shields.io/github/v/release/guacsec/trustify-da-javascript-client?color=yellow&include_prereleases&label=early-access
+
+### Known Issues
+
+- For pip requirements.txt - It's been observed that for python versions 3.11.x, there might be slowness for invoking the analysis.
+  If you encounter a performance issue with version >= 3.11.x, kindly try to set environment variable/option `TRUSTIFY_DA_PIP_USE_DEP_TREE=true`, before calling the analysis.
+
+
+- For maven pom.xml, it has been noticed that using java 17 might cause stack analysis to hang forever.
+  This is caused by maven [`dependency` plugin](https://maven.apache.org/plugins/maven-dependency-plugin/) bug when running with JDK/JRE' JVM version 17.
+
+  To overcome this, you can use any other java version (14,20,21, etc..). ( best way is to install JDK/JRE version different from 17 , and set the location of the installation in environment variable `JAVA_HOME` so maven will use it.)