xrcg 0.9.1.dev0__tar.gz

xrcg-0.9.1.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 CloudEvents Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

xrcg-0.9.1.dev0/PKG-INFO

@@ -0,0 +1,337 @@
+Metadata-Version: 2.4
+Name: xrcg
+Version: 0.9.1.dev0
+Summary: A command-line tool for xRegistry with code generation for messaging and eventing applications
+Author-email: Clemens Vasters <clemensv@microsoft.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: jsonpointer>=3.0.0
+Requires-Dist: pytest>=8.2.2
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: jsonschema>=4.22.0
+Requires-Dist: pydot>=2.0.0
+Requires-Dist: anytree>=2.12.1
+Requires-Dist: avrotize>=2.18.2
+Requires-Dist: avro>=1.11.3
+Requires-Dist: toml>=0.10.2
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: testcontainers>=4.8.2 ; extra == "dev"
+Requires-Dist: pytest>=8.3.3 ; extra == "dev"
+Provides-Extra: dev
+
+# xRegistry Code Generation CLI
+
+[![Python Test](https://github.com/xregistry/codegen/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/xregistry/codegen/actions/workflows/test.yml)
+[![Python Release](https://github.com/xregistry/codegen/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/xregistry/codegen/actions/workflows/build.yml)
+
+Generate production-ready, type-safe messaging SDKs from [xRegistry](https://xregistry.io/) message catalog definitions. One command gives you compile-ready producer/consumer code with tests, dependency management, and protocol-specific bindings.
+
+## Quick Start
+
+**1. Install** (Docker or pip):
+
+```bash
+# Docker (recommended - no Python needed)
+docker pull ghcr.io/xregistry/codegen/xrcg:latest
+
+# Or via pip
+pip install git+https://github.com/xregistry/codegen.git
+```
+
+**2. Generate a Kafka producer** from a sample definition:
+
+```bash
+# Using Docker (Linux/macOS)
+docker run --rm -v $(pwd):/work ghcr.io/xregistry/codegen/xrcg:latest \
+  generate --projectname PrinterEvents --language py --style kafkaproducer \
+  --definitions https://raw.githubusercontent.com/xregistry/codegen/main/samples/message-definitions/inkjet.xreg.json \
+  --output ./generated
+```
+
+```powershell
+# Using Docker (Windows PowerShell)
+docker run --rm -v ${PWD}:/work ghcr.io/xregistry/codegen/xrcg:latest `
+  generate --projectname PrinterEvents --language py --style kafkaproducer `
+  --definitions https://raw.githubusercontent.com/xregistry/codegen/main/samples/message-definitions/inkjet.xreg.json `
+  --output ./generated
+```
+
+```bash
+# Or with pip install (any platform)
+xrcg generate --projectname PrinterEvents --language py --style kafkaproducer \
+  --definitions https://raw.githubusercontent.com/xregistry/codegen/main/samples/message-definitions/inkjet.xreg.json \
+  --output ./generated
+```
+
+This produces a complete Python project with:
+
+- Type-safe producer classes for each message type
+- Strongly-typed data classes generated from Avro schema
+- Integration tests using Testcontainers
+- Ready to use: `cd generated && pip install -e . && pytest`
+
+**3. Or generate for a different platform** — same definition, different target:
+
+```bash
+xrcg generate --projectname ContosoEvents --language cs --style ehproducer \
+  --definitions ./contoso-erp.xreg.json --output ./generated   # C# Event Hubs
+
+xrcg generate --projectname ContosoEvents --language ts --style mqttclient \
+  --definitions ./contoso-erp.xreg.json --output ./generated   # TypeScript MQTT
+
+xrcg generate --projectname ContosoEvents --language py --style kafkaconsumer \
+  --definitions ./contoso-erp.xreg.json --output ./generated   # Python Kafka
+```
+
+## What You Get
+
+Unlike snippet generators, this tool produces **complete SDK-like projects**:
+
+| Feature | What's Generated |
+|---------|------------------|
+| **Type-safe clients** | Producer/consumer classes with strongly-typed methods per message |
+| **Data classes** | Schema-derived classes via [Avrotize](https://github.com/clemensv/avrotize) (JSON Schema, Avro, Protobuf) |
+| **Build files** | `pom.xml`, `.csproj`, `package.json`, `pyproject.toml` with correct dependencies |
+| **Integration tests** | Docker-based tests using Testcontainers for Kafka, MQTT, AMQP brokers |
+| **Project structure** | Language-idiomatic layout ready for IDE import |
+
+**Supported Languages:** Java 21+, C# (.NET 6+), Python 3.9+, TypeScript/JavaScript
+
+**Supported Protocols:** Apache Kafka, MQTT 5.0, AMQP 1.0, Azure Event Hubs, Azure Service Bus, Azure Event Grid, HTTP/CloudEvents
+
+## Generating Code
+
+For complete command documentation, see [Command Reference](docs/commands/README.md).
+
+### The Generate Command
+
+```bash
+xrcg generate --projectname <name> --language <lang> --style <style> \
+  --definitions <file-or-url> --output <dir>
+```
+
+| Option | Description |
+|--------|-------------|
+| `--projectname` | Project/namespace name for generated code |
+| `--language` | Target language: `java`, `cs`, `py`, `ts`, `asyncapi`, `openapi` |
+| `--style` | Protocol binding: `kafkaproducer`, `ehconsumer`, `mqttclient`, etc. |
+| `--definitions` | Path or URL to xRegistry JSON/YAML definition |
+| `--output` | Output directory (will be created/overwritten) |
+| `--templates` | Custom template directory (optional) |
+| `--template-args` | Extra args as `key=value` (optional) |
+
+### Available Templates
+
+Run `xrcg list` to see all available language/style combinations:
+
+```text
+├── java: Java 21+
+│   ├── kafkaproducer, kafkaconsumer     # Apache Kafka
+│   ├── ehproducer, ehconsumer           # Azure Event Hubs  
+│   ├── sbproducer, sbconsumer           # Azure Service Bus
+│   ├── amqpproducer, amqpconsumer       # AMQP 1.0 (RabbitMQ 4+, Artemis, Qpid)
+│   └── mqttclient                       # MQTT 5.0
+├── cs: C# / .NET 6.0+
+│   ├── kafkaproducer, kafkaconsumer
+│   ├── ehproducer, ehconsumer, ehazfn   # Event Hubs + Azure Functions
+│   ├── sbproducer, sbconsumer, sbazfn
+│   ├── egproducer, egazfn               # Event Grid
+│   ├── amqpproducer, amqpconsumer
+│   └── mqttclient
+├── py: Python 3.9+
+│   ├── kafkaproducer, kafkaconsumer
+│   ├── ehproducer, ehconsumer
+│   └── mqttclient
+├── ts: TypeScript
+│   ├── kafkaproducer, kafkaconsumer
+│   ├── ehproducer, ehconsumer
+│   ├── sbproducer, sbconsumer
+│   ├── egproducer, amqpproducer, amqpconsumer
+│   └── mqttclient
+├── asyncapi: AsyncAPI 3.0 definitions
+└── openapi: OpenAPI 3.0 definitions
+```
+
+### Protocol-Specific Examples
+
+<details>
+<summary><strong>AMQP 1.0 (RabbitMQ, Artemis, Qpid)</strong></summary>
+
+```bash
+# Generate Java producer
+xrcg generate --language java --style amqpproducer \
+  --projectname MyProducer --definitions ./catalog.json --output ./out
+
+# Generate C# consumer  
+xrcg generate --language cs --style amqpconsumer \
+  --projectname MyConsumer --definitions ./catalog.json --output ./out
+```
+
+See [RabbitMQ AMQP 1.0 Setup Guide](docs/rabbitmq_amqp_setup.md) for broker configuration.
+
+</details>
+
+<details>
+<summary><strong>AsyncAPI / OpenAPI Generation</strong></summary>
+
+```bash
+# Generate AsyncAPI producer definition
+xrcg generate --language asyncapi --style producer \
+  --projectname MyAPI --definitions ./catalog.json --output ./out
+
+# With binary CloudEvents mode
+xrcg generate --language asyncapi --style producer \
+  --projectname MyAPI --definitions ./catalog.json --output ./out \
+  --template-args ce_content_mode=binary
+
+# Generate OpenAPI for HTTP producer
+xrcg generate --language openapi --style producer \
+  --projectname MyAPI --definitions ./catalog.json --output ./out
+```
+
+</details>
+
+### Custom Templates
+
+Override built-in templates or add new language/style combinations:
+
+```bash
+xrcg generate --templates ./my-templates --language java --style myproducer ...
+```
+
+Template directory structure mirrors the built-in templates. See [Authoring Templates](docs/authoring_templates.md).
+
+## Installation Details
+
+### Docker (Recommended)
+
+```bash
+docker pull ghcr.io/xregistry/codegen/xrcg:latest
+```
+
+Create a shell alias for convenience:
+
+```bash
+# Linux/macOS (.bashrc or .zshrc)
+alias xrcg='docker run --rm -v $(pwd):/work ghcr.io/xregistry/codegen/xrcg:latest'
+
+# Windows PowerShell (profile)
+function xrcg { docker run --rm -v ${PWD}:/work ghcr.io/xregistry/codegen/xrcg:latest $args }
+```
+
+> **Note:** File paths must be relative to your current directory due to Docker volume mapping.
+
+### Python Package
+
+Requires Python 3.10+:
+
+```bash
+pip install git+https://github.com/xregistry/codegen.git
+```
+
+For development setup, see [Development Environment](docs/development_environment.md).
+
+## Working with xRegistry Definitions
+
+The generator consumes [xRegistry](https://xregistry.io/) message catalog documents—JSON/YAML files that describe schemas, messages, and endpoints. You can:
+
+- Use existing definition files (see [samples/message-definitions/](samples/message-definitions/))
+- Create definitions manually following the [xRegistry spec](https://github.com/xregistry/spec)
+- Manage definitions using the CLI's `manifest` or `catalog` commands
+
+### Sample Definitions
+
+| Sample | Description |
+|--------|-------------|
+| [contoso-erp.xreg.json](samples/message-definitions/contoso-erp.xreg.json) | ERP system events (orders, payments, inventory) |
+| [fabrikam-motorsports.xreg.json](samples/message-definitions/fabrikam-motorsports.xreg.json) | Motorsports telemetry stream |
+| [inkjet.xreg.json](samples/message-definitions/inkjet.xreg.json) | IoT printer events |
+
+### Managing Definitions with CLI
+
+<details>
+<summary><strong>Manifest Mode (Local Files)</strong></summary>
+
+Work with local JSON files for version-controlled, offline workflows:
+
+```bash
+# Create a message group
+xrcg manifest messagegroup add --manifest=./catalog.json --id=orders --envelope=CloudEvents/1.0
+
+# Add a message definition
+xrcg manifest message add --manifest=./catalog.json --messagegroupid=orders \
+  --id=OrderPlaced --description="Order was placed"
+
+# Validate the file
+xrcg validate --definitions ./catalog.json
+```
+
+</details>
+
+<details>
+<summary><strong>Catalog Mode (Remote Registry)</strong></summary>
+
+Interact with a remote xRegistry HTTP API for team collaboration:
+
+```bash
+# Configure registry connection
+xrcg config set registry.base_url https://registry.example.com
+xrcg config set registry.auth_token <token>
+
+# Work with remote registry
+xrcg catalog messagegroup add --id=orders ...
+xrcg catalog message list --messagegroupid=orders
+```
+
+Currently supports [xrserver](https://github.com/xregistry/xrserver/) registry.
+
+</details>
+
+### Validate Command
+
+Check definition files for errors:
+
+```bash
+xrcg validate --definitions ./catalog.json
+xrcg validate --definitions https://example.com/catalog.json
+```
+
+### Configuration
+
+Store defaults to avoid repetition:
+
+```bash
+xrcg config set defaults.language java
+xrcg config set defaults.output_dir ./generated
+xrcg config list
+```
+
+Config location: `~/.config/xrcg/config.json` (Linux), `%APPDATA%\xrcg\config.json` (Windows)
+
+## What is xRegistry?
+
+[xRegistry](https://xregistry.io/) is a CNCF project defining a standard format for describing messaging and eventing infrastructure. A message catalog document contains:
+
+- **Schema groups** — Payload schemas (JSON Schema, Avro, Protobuf)
+- **Message groups** — Message definitions with [CloudEvents](https://cloudevents.io) envelope metadata
+- **Endpoints** — Protocol bindings (Kafka topics, AMQP queues, HTTP endpoints)
+
+The code generator follows references between these elements to produce cohesive, type-safe SDKs.
+
+## Community
+
+- **Slack:** [#cloudevents on CNCF Slack](http://slack.cncf.io/)
+- **Mailing list:** [cncf-cloudevents@lists.cncf.io](https://lists.cncf.io/g/cncf-cloudevents)
+- **Governance:** [GOVERNANCE.md](https://github.com/xregistry/spec/blob/main/docs/GOVERNANCE.md)
+- **Contributing:** [CONTRIBUTING.md](https://github.com/xregistry/spec/blob/main/docs/CONTRIBUTING.md)
+
+## License
+
+[Apache 2.0](LICENSE)
+