Metadata-Version: 2.4
Name: cnheat
Version: 0.1.9
Summary: Python module for interacting with the Cambium Networks cnHeat API
Author-email: JckHmr <cjosey@cjevolutions.com>
License: MIT
Project-URL: Homepage, https://github.com/JckHamm3r/cnHeat
Project-URL: Issues, https://github.com/JckHamm3r/cnHeat/issues
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: requests

# cnheat

**Python module for interacting with the Cambium Networks cnHeat API** — manage sites, radios, antennas, predictions, users, and subscriptions programmatically.

This library provides a simple and powerful Python interface to the Cambium cnHeat API, enabling you to automate RF planning, data management, and network operations with minimal effort.

---

## 🚀 Features

- 🔐 Authenticate using client ID and secret
- 🏗 Create, list, rename, and delete sites
- 📡 Add and configure radios using antenna templates
- 📊 Generate and manage heatmap predictions
- 👥 Add or remove users with permission control
- 📦 Manage subscriptions and renewal status
- 📁 Convert API responses to lists or dictionaries
- ✅ Includes helper methods for working with `site_id`, `antenna_id`, and `radio_id` cleanly

---

## 📦 Installation

Install from PyPI:

```bash
pip install cnheat
```


🔧 Basic Usage
```bash
from cnheat import cnHeat

cn = cnHeat(client_id="your_id", client_secret="your_secret")
sites = cn.get_sites()
print(sites)
```

📊 Example: Create a Radio
```bash
site_id = cn.get_sites()[0]['id']
antenna_id = cn.get_antennas(3.6)[0]['id']
cn.create_radio(site_id, 3.6, antenna_id, azimuth=90)
```

📊 Example: Create a Prediction
```bash
radios = cn.get_site_radios(site_id)
radio_ids = [r['id'] for r in radios]
cn.create_prediction("Coverage Map", radio_ids)
```

---


