[ ~/proxmox-sdk ]tty0

   ___                              ___ ___  _  __
  | _ \_ _ _____ ___ __  _____ __  / __|   \| |/ /
  |  _/ '_/ _ \ \ / /  \/ _ \ \ /  \__ \ |) | ' <
  |_| |_| \___/_\_\_/\_\___/_\_\   |___/___/|_|\_\
   o p e n a p i  ·  f a s t a p i  ·  m o c k + r e a l

emerson@netdevops:~/proxmox-sdk$ ./describe.sh proxmox-sdk

Schema-driven FastAPI SDK for the Proxmox API — generated, dual-mode, OpenAPI-first.

proxmox-sdk is a FastAPI package that mirrors the Proxmox VE API as a fully typed OpenAPI surface, with 646 endpoints generated from Proxmox VE 8.1.

It runs in two modes out of the box: a mock mode (default) with auto-generated CRUD data so you can develop without a real cluster, and a real mode that proxies validated requests to a live Proxmox host.

license=MITpython=3.10+release=v0.0.3.post1

›overview

emerson@netdevops:~/proxmox-sdk$ cat OVERVIEW.md

proxmox-sdk is a FastAPI package that mirrors the Proxmox VE API as a fully typed OpenAPI surface, with 646 endpoints generated from Proxmox VE 8.1.

It runs in two modes out of the box: a mock mode (default) with auto-generated CRUD data so you can develop without a real cluster, and a real mode that proxies validated requests to a live Proxmox host.

›features

emerson@netdevops:~/proxmox-sdk$ ./features --list

  • ├─646 pre-generated Proxmox VE 8.1 endpoints with full OpenAPI schema
  • ├─Dual mode: mock (default) for development, real for production
  • ├─Auto-generated mock data with in-memory CRUD operations
  • ├─Real API proxy with request/response validation
  • ├─Code generation: crawls the Proxmox API Viewer into OpenAPI
  • ├─Multi-version support, with 'latest' mapped to the official viewer
  • ├─FastAPI-generated Swagger UI at /docs
  • ├─Optional CLI / TUI extras

›stack

emerson@netdevops:~/proxmox-sdk$ cat stack.txt

  • › Python
  • › FastAPI
  • › OpenAPI 3.0
  • › Pydantic

›install

emerson@netdevops:~/proxmox-sdk$ install

install
emerson@netdevops:~$ pip install proxmox-sdk

# Then visit /docs on the running app for live OpenAPI / Swagger.

›repo

emerson@netdevops:~/proxmox-sdk$ repo:stats

$ gh repo view emersonfelipesp/proxmox-sdk --json
stars
1
forks
0
lang
Python
release
v0.0.3.post1

static · from public/github-data

›links

emerson@netdevops:~/proxmox-sdk$ links