Skip to main content

This is a non-official package that leverages the Harness API using Python.

Project description

Harness Python SDK

Welcome to the Harness Python SDK! This SDK provides a convenient way to interact with the Harness platform's APIs using Python.

Prerequisites

Before using the SDK, ensure you have the following:

  • Harness Platform API Key: You'll need an API key to authenticate with the Harness API. You can create a personal API key.
  • Python 3 or higher: This SDK requires Python 3 or higher to run.
  • Account Identifier: The account identifier is required for authenticating with the Harness API. You can find this identifier in the URL when you're logged into your Harness account. For example, in the URL https://app.harness.io/ng/account/Fak3Acc0unt1D/settings/overview, the account identifier is Fak3Acc0unt1D.

Make sure you have installed the required libraries using the following commands:

pip install requests pyyaml
  • requests: This library is required for making HTTP requests to the Harness platform.
  • pyyaml: This library is necessary for handling YAML files, which may be required by the script for configuration or data manipulation.

Getting Started

To get started with the SDK, you'll need to authenticate with the Harness API. Here's how you can do it:

import os
from harness_sdk import HarnessBaseService

harness_service = HarnessBaseService(os.environ.get('HARNESS_PLATFORM_API_KEY'), "my-account-identifier")

Example 1 - Listing Services

Use the following code to list all services:

harness_service.services.fetch_services()

Example 2 - Listing Connectors using the old API

To list connectors using the old API, use the following code:

harness_service.connectors.old.fetch_connectors_listV2(
    data={
        "types": ["HttpHelmRepo"],
        "filterType": "Connector"
    },
    org_identifier=org_identifier,
    project_identifier=project_identifier
)

Reference

Here's a reference to the available classes in the SDK:

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

harness_py_sdk-0.0.3.tar.gz (114.5 kB view details)

Uploaded Source

Built Distribution

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

harness_py_sdk-0.0.3-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file harness_py_sdk-0.0.3.tar.gz.

File metadata

  • Download URL: harness_py_sdk-0.0.3.tar.gz
  • Upload date:
  • Size: 114.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.6

File hashes

Hashes for harness_py_sdk-0.0.3.tar.gz
Algorithm Hash digest
SHA256 94970e94456faa10d18b590c670256f3e744305fd80bea90405da589def442ec
MD5 964a598d687ab3f80d13ea8bc9f871e6
BLAKE2b-256 b33e00f98806fba30ae93c616330c5bdc20a6a4b5a3da5246661cdf59d82b463

See more details on using hashes here.

File details

Details for the file harness_py_sdk-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: harness_py_sdk-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.6

File hashes

Hashes for harness_py_sdk-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a2d2b59ddd6315f1bf02e58b9af0b815d4a2f8c64caaea6084dcc399e8fd8568
MD5 56257624ee57a8390304c9476c414aeb
BLAKE2b-256 ce2482d84cfbc07123a0dbbaae178d51f47f70b86f94cbcbb1f50d75e116bedd

See more details on using hashes here.

Supported by

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