Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
<PackageProjectUrl>https://github.com/Chrison-dev/ProxmoxSharp</PackageProjectUrl>
<RepositoryType>git</RepositoryType>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<!-- Embed the repo README in every package so nuget.org renders it. -->
<PackageReadmeFile>README.md</PackageReadmeFile>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<!-- Embed symbols in the assembly (GitHub Packages doesn't take .snupkg). -->
<DebugType>embedded</DebugType>
Expand All @@ -21,4 +23,9 @@
<UseAppHost>false</UseAppHost>
</PropertyGroup>

<!-- Pack the repo-root README into every packable project (PackageReadmeFile above). -->
<ItemGroup Condition="Exists('$(MSBuildThisFileDirectory)README.md')">
<None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="\" Visible="false" />
</ItemGroup>

</Project>
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,38 @@
# ProxmoxSharp

[![NuGet](https://img.shields.io/nuget/v/Chrison.ProxmoxSharp.svg)](https://www.nuget.org/packages/Chrison.ProxmoxSharp/)
[![Downloads](https://img.shields.io/nuget/dt/Chrison.ProxmoxSharp.svg)](https://www.nuget.org/packages/Chrison.ProxmoxSharp/)
[![ci](https://github.com/Chrison-dev/ProxmoxSharp/actions/workflows/ci.yml/badge.svg)](https://github.com/Chrison-dev/ProxmoxSharp/actions/workflows/ci.yml)
[![Built with Fallout](https://img.shields.io/badge/built%20with-Fallout-8A2BE2)](https://github.com/Fallout-build/Fallout)
[![License: MIT](https://img.shields.io/github/license/Chrison-dev/ProxmoxSharp.svg)](LICENSE)

A C# API client for Proxmox VE — **mostly code-generated from Proxmox's own
published API schema**, with a thin hand-written runtime for auth and transport.

Built to be dogfooded by the [Homelab](https://github.com/Chrison-dev/Homelab)
```sh
dotnet add package Chrison.ProxmoxSharp
dotnet tool install -g Chrison.ProxmoxSharp.Cli # the `proxmoxsharp` CLI
```

Built to be dogfooded by the [Homelab](https://github.com/Chrison-Homelab/Homelab)
hub's C#-native IaC (the Discover → Converge path). Design + roadmap live in the
hub at `docs/plans/BL-009-proxmoxsharp-codegen.md`.

## Approach

```mermaid
flowchart LR
APIDOC["📜 apidoc.js<br/>(pinned, from our node)"] --> SG["🔧 ProxmoxSharp.SchemaGen<br/>apidoc → OpenAPI 3.0"]
SG --> KIOTA["⚙️ Kiota (pinned tool)<br/>generate C# client"]
KIOTA --> API["📦 ProxmoxSharp.Api<br/>generated · tracks PVE version"]
API --> RT["✍️ ProxmoxSharp<br/>hand-written runtime<br/>(token auth · {data:…} envelope)"]
RT --> CLI["🖥️ proxmoxsharp CLI"]
classDef gen fill:#e0e7ff,stroke:#4f46e5;
class API gen;
```
apidoc.js (version-matched, pulled from our node)
│ ProxmoxSharp.SchemaGen → OpenAPI 3.0
Kiota (pinned dotnet tool) → generated C# request builders + models (ProxmoxSharp.Api)
ProxmoxSharp = hand-written runtime over it (PVEAPIToken auth, {data:…} envelope)
```

The generated client is **regenerated on build** (incrementally — only when the
schema changes) and **not committed**.

The generated client is **regenerated on build** (incrementally — only when the
schema changes) and **not committed**. Day-to-day work on the hand-written
Expand Down
2 changes: 1 addition & 1 deletion src/ProxmoxSharp/ProxmoxSharp.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Bumped to 0.2.0 so the active 0.2.0-preview.N line outranks the earlier
0.1.0 stable in NuGet ordering — a `0.1.0-preview.*` float would otherwise
resolve the stale 0.1.0 stable (prereleases sort below their release). -->
<VersionPrefix>0.2.0</VersionPrefix>
<VersionPrefix>0.2.1</VersionPrefix>
<!-- Public nuget.org ID uses the reserved Chrison.* prefix (the bare
'ProxmoxSharp' ID is taken on nuget.org by an unrelated project).
AssemblyName/RootNamespace stay 'ProxmoxSharp' (project name) so
Expand Down
Loading