Metadata-Version: 2.4
Name: cccAPI
Version: 0.0.1
Summary: Python API Client for CCC
Home-page: https://github.com/atripathy86/cccAPI
Author: Aalap Tripathy
Author-email: Aalap Tripathy <atripathy.bulk@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/atripathy86/cccAPI
Project-URL: Documentation, https://github.com/atripathy86/cccAPI
Project-URL: Source, https://github.com/atripathy86/cccAPI
Project-URL: Issues, https://github.com/atripathy86/cccAPI/issues
Keywords: ccc,compute cluster controller,fleet,api,client,hpc
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.26.0
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

# ccc_client

This package provides a simple, modular SDK for the CCC REST API.

## Features

* Automatically handles authentication and renewal
* Graceful error management
* Logically organized modules
* Easily maintained

## Installation

**Install using `pip`:**

```bash
pip install cccAPI 
```

**Install from source:**

```bash
git clone https://github.hpe.com/hpe/cccAPI.git
cd cccAPI
pip install -e .
```

## Quick Start

### Initialize the Client

```python
import json
from cccAPI import cccAPIClient
client = cccAPIClient("https://localhost:8000/cmu/v1", "root", "your-password")
```

### Example Usage

#### Get Nodes

```python
nodes = client.nodes.show_nodes()
print(json.dumps(nodes, indent=4))
```

#### Get specific Node

```python
#Specific node named BartC01n1-091
node = client.nodes.show_node("BartC01n1-091")
print(json.dumps(node, indent=4))
```

#### Get specific Node/fields 
- Allowed fields are: 

```python 
query_params = {"fields": "name,id,uuid,network.name,network.ipAddress,network.macAddress"}
specific_nodes=client.nodes.show_nodes(query_params)
print(json.dumps(specific_nodes, indent=4))
```

## API Modules

| Module                | Description |
|----------------------|-------------|
| `nodes`           | Query history, top clients/domains, DNS stats |
| `image_groups`       | Enable/disable blocking |
| `network_groups`  | Create, update, and delete groups |
| `custom_groups` | Allow/block domains (exact & regex) |
| `resource_features` | Manage client-specific rules |
| `image_capture_deployment`   | Manage blocklists (Adlists) |
| `power_operation`            | Modify CCC configuration |
| `application`          | Get CCC core process (FTL) info |
| `architecture`              | Manage DHCP leases |
| `management_cards`      | View network devices, interfaces, routes |
| `tasks`           | Flush logs, restart services |

## License

This project is license under the [MIT license](LICENSE).
