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 isFak3Acc0unt1D.
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:
- Connectors: Documentation
- Old Connectors: Documentation
- Pipelines: Documentation
- Services: Documentation
- Templates: Documentation
Project details
Release history Release notifications | RSS feed
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file harness_py_sdk-0.0.9.tar.gz.
File metadata
- Download URL: harness_py_sdk-0.0.9.tar.gz
- Upload date:
- Size: 114.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db33bc846c432d5322d0c5c1460def0d3d3c8d3e542f7c145a02fe87c92e14d4
|
|
| MD5 |
fcde18f7ab7881aa8e8d5d4164e2ff37
|
|
| BLAKE2b-256 |
187d875f4033b4af291d82163b75e8d0cf9e107f6663a0a2c4cb7f0e84cc5605
|
File details
Details for the file harness_py_sdk-0.0.9-py3-none-any.whl.
File metadata
- Download URL: harness_py_sdk-0.0.9-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6357a9f936a9aa9309c405bf98013089d540b4db1d8b6b202cceda4e7f6cf04f
|
|
| MD5 |
888e24079873ddcb1e526a1ae9b863e1
|
|
| BLAKE2b-256 |
9e6e69751e59f8ae7d55c0d48622337705e8d0da07d93d6c41232295f95241d6
|