sonatype-guide-api-client

REST API into Sonatype Guide.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 202606
  • Package version: 1.0.0
  • Generator version: 7.16.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/sonatype-nexus-community

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/sonatype-nexus-community/sonatype-guide-api-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/sonatype-nexus-community/sonatype-guide-api-client.git)

Then import the package:

import sonatype_guide_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sonatype_guide_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sonatype_guide_api_client
from sonatype_guide_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.guide.sonatype.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sonatype_guide_api_client.Configuration(
    host = "https://api.guide.sonatype.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer-jwt
configuration = sonatype_guide_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with sonatype_guide_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonatype_guide_api_client.BillingApi(api_client)

    try:
        # Get billing information
        api_response = api_instance.get_billing()
        print("The response of BillingApi->get_billing:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingApi->get_billing: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.guide.sonatype.com

Class Method HTTP request Description
BillingApi get_billing GET /billing Get billing information
BillingApi get_invoice_pdf GET /billing/invoices/{invoiceId}/pdf Download invoice PDF
BillingApi get_plans GET /billing/plans Get all available plans
BillingApi get_user_invoice_history GET /billing/invoices Get user invoice history
ComponentsApi get_component_dependencies_by_purl_query_param GET /components/dependencies Get dependencies for a component by coordinates (query parameters)
ComponentsApi get_component_detail_by_purl_query_param GET /components/detail Get component detail by coordinates (query parameters)
ComponentsApi get_component_versions_by_purl_query_param GET /components/versions Get all component versions by coordinates (query parameters)
ComponentsApi get_component_vulnerabilities_by_purl_query_param GET /components/vulnerabilities Get vulnerabilities for a component by coordinates (query parameters)
ComponentsApi get_latest_version POST /components/latest-version Get latest version of a component
CurrentUserOrganizationApi accept_invitation POST /users/me/organization/invitations/{invitationToken}/accept Accept organization invitation
CurrentUserOrganizationApi bulk_remove_members_or_invitations DELETE /users/me/organization/members Bulk remove members or invitations from organization
CurrentUserOrganizationApi dismiss_onboarding_banner DELETE /users/me/organization/onboarding-banner Dismiss onboarding banner
CurrentUserOrganizationApi get_current_user_organization GET /users/me/organization Get current user's organization
CurrentUserOrganizationApi get_onboarding_banner_status GET /users/me/organization/onboarding-banner Get onboarding banner status
CurrentUserOrganizationApi invite_users POST /users/me/organization/members/invite Invite users to current user's an organization
CurrentUserOrganizationApi leave_organization DELETE /users/me/organization/membership Leave organization
CurrentUserOrganizationApi remove_member_or_invitation DELETE /users/me/organization/members/{email} Remove member or invitation from organization
CurrentUserOrganizationApi retrieve_organization_members_as_csv GET /users/me/organization/members Retrieve current user's organization members and invitees
CurrentUserOrganizationApi update_organization PUT /users/me/organization Update current user's organization
CurrentUserTokensApi create_token POST /users/me/tokens Create a new Personal Access Token
CurrentUserTokensApi get_token_by_id GET /users/me/tokens/{tokenId} Get a Personal Access Token by ID
CurrentUserTokensApi list_tokens GET /users/me/tokens List all Personal Access Tokens
CurrentUserTokensApi revoke_token DELETE /users/me/tokens/{tokenId} Revoke a Personal Access Token
OSSIndexCompatibilityApi get_component_report GET /api/v3/authorized/component-report/** Get component report by PURL
OSSIndexCompatibilityApi get_component_report1 GET /api/v3/component-report/** Get component report by PURL
OSSIndexCompatibilityApi get_component_reports POST /api/v3/component-report Get component reports for multiple PURLs
OSSIndexCompatibilityApi get_component_reports1 POST /api/v3/authorized/component-report Get component reports for multiple PURLs
OSSIndexCompatibilityApi get_version GET /api/v3/version Get API version
RecommendationsApi get_recommendations POST /recommendations Get version upgrade recommendations
UsageApi get_credit_periods GET /usage/credit-periods Get credit periods
UsageApi get_cumulative_usage GET /usage/cumulative Get cumulative credit usage for a billing period
UsageApi get_ossi_usage_history GET /usage/ossi-history Get historical OSSI usage
UsageApi get_usage GET /usage Get usage information
VulnerabilitiesApi get_vulnerability_affected_components GET /vulnerabilities/{id}/components Get affected components for a vulnerability
VulnerabilitiesApi get_vulnerability_by_ref_id GET /vulnerabilities/{id} Get vulnerability by ID

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer-jwt

  • Type: Bearer authentication (JWT)

ossi-basic-auth

  • Type: HTTP basic authentication

user-token

  • Type: Bearer authentication

Author

community@sonatype.com

Project links

Data verified by PyPI on Jun 29, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.202608.3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for sonabot from gravatar.com sonabot

Credits

Author: Sonatype Community Maintainers

GitHub Statistics

Data verified by PyPI on Jun 29, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache 2.0

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Sonatype Guide API

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sonatype_guide_api_client-1.202606.2.tar.gz (67.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sonatype_guide_api_client-1.202606.2-py3-none-any.whl (122.9 kB view details)

Uploaded Python 3

File details

Details for the file sonatype_guide_api_client-1.202606.2.tar.gz.

File metadata

File hashes

Hashes for sonatype_guide_api_client-1.202606.2.tar.gz
Algorithm Hash digest
SHA256 5306a8e31d11c33a21f3001e685d46b2a1c063121b9398b01c8d1a3eedf369c6
MD5 2f5a07e73b1a9fccef1cdab616b40be5
BLAKE2b-256 ecd8ea37b077f047635d93a05e4b65f6674404ce26521310c82dfac38e0e7da7

See more details on using hashes here.

Provenance

The following attestation bundles were made for sonatype_guide_api_client-1.202606.2.tar.gz:

Publisher: release.yaml on sonatype-nexus-community/sonatype-guide-api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sonatype_guide_api_client-1.202606.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sonatype_guide_api_client-1.202606.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e196c88342e6686e80f672e2136050f63b24f1c6cb983bea05c6adcb63eabb95
MD5 f1a93e87935e6fec031e08436fb499ca
BLAKE2b-256 e04c19306ed11094c5b16411235594e5ce8671b45c29b62c1154fb0c59a153d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for sonatype_guide_api_client-1.202606.2-py3-none-any.whl:

Publisher: release.yaml on sonatype-nexus-community/sonatype-guide-api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.202608.3

2 files

1.202608.2

2 files

1.202608.1

2 files

1.202608.0

2 files

1.202607.2

2 files

1.202607.1

2 files

1.202607.0

2 files

This release

1.202606.2 This release

2 files

1.202606.1

2 files

1.202605.3

2 files

1.202605.2

2 files

1.202605.1

2 files

1.202605.0

2 files

0.1.0

2 files

0.0.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page