Skip to content

PyPNMApps/Postman-PyPNMApps-API

Repository files navigation

Postman PyPNMApps API Collections

Python CI (Ubuntu) MkDocs Site Build MkDocs Pages Deploy MkDocs License: Apache-2.0 Docs

This repository contains Postman collections, environment/globals files, and example visualizers for PyPNM API workflows.

It includes:

  • Postman collections (PyPNM, PyPNM-CMTS)
  • environment and globals exports
  • visual/ example Postman Visualizer HTML + JSON fixtures

Basic Setup

  1. Install Postman Desktop (Ubuntu/Windows): docs/postman-install.md
  2. Clone this repository:
git clone https://github.com/PyPNMApps/Postman-PyPNMApps-API.git
cd Postman-PyPNMApps-API
  1. Import collections/environment/globals and configure pypnm_url:
    • docs/postman-import-and-navigation.md

Install (Local Tooling + Docs)

./install.sh

install.sh now prints Windows (PowerShell) command examples by default. Use Linux/macOS examples instead:

./install.sh --os-linux

Run the local MkDocs site (default local docs port for this repo: 8030):

source .venv/bin/activate
tools/docs/build_visual_docs.py
mkdocs serve -a 127.0.0.1:8030

Open:

  • http://127.0.0.1:8030/

Start Here