oapi-profile-builder 3.5.0__tar.gz → 3.6.1__tar.gz

{oapi_profile_builder-3.5.0/src/oapi_profile_builder.egg-info → oapi_profile_builder-3.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.5.0
+Version: 3.6.1
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -181,6 +181,20 @@ OGC API - EDR CITE Results
 
 ## GitHub Actions
 
+### Self-service: generate artifacts from an issue (no fork, no install)
+
+Anyone with a GitHub account can generate artifacts from their own config without cloning or installing anything:
+
+1. Open a new issue using the **"Generate profile artifacts"** template ([New issue](../../issues/new/choose)).
+2. Paste your profile YAML into the config field and submit.
+3. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days). Optionally tick "Compile a PDF?" to also get a Metanorma PDF.
+
+The workflow only runs the generator over your declarative config — it never executes user-supplied code — and comments back on both success and failure. Don't paste secrets: the artifacts are attached to a public workflow run.
+
+> Maintainers: create a `profile-request` label so requests are easy to filter (the workflow gates on a marker in the issue body, so it works even before the label exists).
+
+### Use the action in your own workflow
+
 No local install needed. Add this to any workflow to generate profile artifacts from a config file:
 
 ```yaml
@@ -239,7 +253,7 @@ Everything about the document — cover, title-page metadata, legal page, footer
 | PDF colours (titles, tables, cover, backgrounds) | `document_metadata.colors` | `:presentation-metadata-color-*:` |
 | Page-ii legal text (copyright / license / notice) | `document_metadata.boilerplate` | `:boilerplate-authority:` |
 | Footer organisation name | `document_metadata.copyright_holder` | `:copyright-holder:` |
-| Cover layout (logo size/position, tagline/title size, bold edition) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, bold_edition}` | Generated cover image |
+| Cover layout (logo size/position, tagline/title/edition-date size, bold edition+date) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, edition_date_font_size, bold_edition}` | Generated cover image |
 | Cover date | `document_metadata.doc_pub_date` | Long-format date on the generated cover + `:published-date:` |
 | Remove the OGC logo from the legal page | `document_metadata.suppress_flavor_logo` | targeted `:pdf-stylesheet-override:` |
 | Remove OGC design (crossing lines, circled numbers, rules, navy divider pages) | `document_metadata.suppress_design_elements` (or the individual `suppress_crossing_lines` / `plain_section_numbers` / `suppress_title_underlines`) | `:pdf-stylesheet-override:` + colour attributes |
@@ -695,7 +709,7 @@ When present, generates `asyncapi.yaml` alongside `openapi.yaml`.
 pubsub:
   broker_host: my-broker.example.com
   broker_port: 5672
-  protocol: amqp          # amqp | mqtt | kafka
+  protocol: amqp          # amqp | amqp1 | mqtt | kafka
   collections:
     - my_collection
   filters:
@@ -704,6 +718,40 @@ pubsub:
       type: string
 ```
 
+`broker_host`/`broker_port`/`protocol` synthesise a single implicit
+`production` AsyncAPI server. To describe an exact transport topology instead —
+e.g. a native WebSocket `/ws` endpoint plus AMQP 1.0 and MQTT brokers, as the
+`nws_connect_profile.yaml` example does — list them explicitly under `servers`.
+When `servers` is set, the implicit `production` server is **not** emitted:
+
+```yaml
+pubsub:
+  broker_host: edr-broker
+  broker_port: 5672
+  protocol: amqp1         # AMQP 1.0 (e.g. RabbitMQ 4.x native)
+  collections: [water_gauge, wwa]
+  servers:
+    - name: websocket_secure
+      description: Native WebSocket live map (production)
+      host: ''
+      protocol: wss       # amqp | amqp1 | mqtt | kafka | ws | wss
+      pathname: /ws
+    - name: amqp
+      description: AMQP 1.0 broker (RabbitMQ 4.x native AMQP 1.0)
+      host: 'edr-broker:5672'
+      protocol: amqp1
+    - name: mqtt
+      description: MQTT broker (RabbitMQ MQTT plugin)
+      host: 'edr-broker:1883'
+      protocol: mqtt
+  collection_filters:     # per-collection filter overrides
+    water_gauge:
+      filters:
+        - name: flood_stages
+          description: Alert for selected flood stages
+          type: array
+```
+
 ---
 
 ### `document_metadata`
@@ -773,11 +821,12 @@ document_metadata:
     font_italic: "Source Sans Pro"  # optional italic face for the tagline
     watermark: "DRAFT"             # optional diagonal watermark stamped on the cover
     # --- cover layout (all optional) ---
-    logo_width: 200                # target logo width in px (default 420)
+    logo_width: 300                # target logo width in px (default 420)
     logo_y: 100                    # logo vertical offset from top in px (default 180)
     tagline_font_size: 20          # tagline point size (default 30)
     title_font_size: 40            # title point size (default 54)
-    bold_edition: true             # render the "Edition X" line in bold (default false)
+    edition_date_font_size: 22     # edition/date point size (default 24)
+    bold_edition: true             # render the "Edition X" and "Dated ..." lines in bold (default false)
   colors:
     text: "#000000"                # body text
     cover_text: "#1F3864"          # cover text / section numbers / ToC

{oapi_profile_builder-3.5.0 → oapi_profile_builder-3.6.1}/README.md

@@ -134,6 +134,20 @@ OGC API - EDR CITE Results
 
 ## GitHub Actions
 
+### Self-service: generate artifacts from an issue (no fork, no install)
+
+Anyone with a GitHub account can generate artifacts from their own config without cloning or installing anything:
+
+1. Open a new issue using the **"Generate profile artifacts"** template ([New issue](../../issues/new/choose)).
+2. Paste your profile YAML into the config field and submit.
+3. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days). Optionally tick "Compile a PDF?" to also get a Metanorma PDF.
+
+The workflow only runs the generator over your declarative config — it never executes user-supplied code — and comments back on both success and failure. Don't paste secrets: the artifacts are attached to a public workflow run.
+
+> Maintainers: create a `profile-request` label so requests are easy to filter (the workflow gates on a marker in the issue body, so it works even before the label exists).
+
+### Use the action in your own workflow
+
 No local install needed. Add this to any workflow to generate profile artifacts from a config file:
 
 ```yaml
@@ -192,7 +206,7 @@ Everything about the document — cover, title-page metadata, legal page, footer
 | PDF colours (titles, tables, cover, backgrounds) | `document_metadata.colors` | `:presentation-metadata-color-*:` |
 | Page-ii legal text (copyright / license / notice) | `document_metadata.boilerplate` | `:boilerplate-authority:` |
 | Footer organisation name | `document_metadata.copyright_holder` | `:copyright-holder:` |
-| Cover layout (logo size/position, tagline/title size, bold edition) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, bold_edition}` | Generated cover image |
+| Cover layout (logo size/position, tagline/title/edition-date size, bold edition+date) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, edition_date_font_size, bold_edition}` | Generated cover image |
 | Cover date | `document_metadata.doc_pub_date` | Long-format date on the generated cover + `:published-date:` |
 | Remove the OGC logo from the legal page | `document_metadata.suppress_flavor_logo` | targeted `:pdf-stylesheet-override:` |
 | Remove OGC design (crossing lines, circled numbers, rules, navy divider pages) | `document_metadata.suppress_design_elements` (or the individual `suppress_crossing_lines` / `plain_section_numbers` / `suppress_title_underlines`) | `:pdf-stylesheet-override:` + colour attributes |
@@ -648,7 +662,7 @@ When present, generates `asyncapi.yaml` alongside `openapi.yaml`.
 pubsub:
   broker_host: my-broker.example.com
   broker_port: 5672
-  protocol: amqp          # amqp | mqtt | kafka
+  protocol: amqp          # amqp | amqp1 | mqtt | kafka
   collections:
     - my_collection
   filters:
@@ -657,6 +671,40 @@ pubsub:
       type: string
 ```
 
+`broker_host`/`broker_port`/`protocol` synthesise a single implicit
+`production` AsyncAPI server. To describe an exact transport topology instead —
+e.g. a native WebSocket `/ws` endpoint plus AMQP 1.0 and MQTT brokers, as the
+`nws_connect_profile.yaml` example does — list them explicitly under `servers`.
+When `servers` is set, the implicit `production` server is **not** emitted:
+
+```yaml
+pubsub:
+  broker_host: edr-broker
+  broker_port: 5672
+  protocol: amqp1         # AMQP 1.0 (e.g. RabbitMQ 4.x native)
+  collections: [water_gauge, wwa]
+  servers:
+    - name: websocket_secure
+      description: Native WebSocket live map (production)
+      host: ''
+      protocol: wss       # amqp | amqp1 | mqtt | kafka | ws | wss
+      pathname: /ws
+    - name: amqp
+      description: AMQP 1.0 broker (RabbitMQ 4.x native AMQP 1.0)
+      host: 'edr-broker:5672'
+      protocol: amqp1
+    - name: mqtt
+      description: MQTT broker (RabbitMQ MQTT plugin)
+      host: 'edr-broker:1883'
+      protocol: mqtt
+  collection_filters:     # per-collection filter overrides
+    water_gauge:
+      filters:
+        - name: flood_stages
+          description: Alert for selected flood stages
+          type: array
+```
+
 ---
 
 ### `document_metadata`
@@ -726,11 +774,12 @@ document_metadata:
     font_italic: "Source Sans Pro"  # optional italic face for the tagline
     watermark: "DRAFT"             # optional diagonal watermark stamped on the cover
     # --- cover layout (all optional) ---
-    logo_width: 200                # target logo width in px (default 420)
+    logo_width: 300                # target logo width in px (default 420)
     logo_y: 100                    # logo vertical offset from top in px (default 180)
     tagline_font_size: 20          # tagline point size (default 30)
     title_font_size: 40            # title point size (default 54)
-    bold_edition: true             # render the "Edition X" line in bold (default false)
+    edition_date_font_size: 22     # edition/date point size (default 24)
+    bold_edition: true             # render the "Edition X" and "Dated ..." lines in bold (default false)
   colors:
     text: "#000000"                # body text
     cover_text: "#1F3864"          # cover text / section numbers / ToC

{oapi_profile_builder-3.5.0 → oapi_profile_builder-3.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "oapi-profile-builder"
-version = "3.5.0"
+version = "3.6.1"
 description = "Authoritative tooling for creating OGC API Service Profiles (EDR, Features)"
 readme = "README.md"
 license = { file = "LICENSE" }

{oapi_profile_builder-3.5.0 → oapi_profile_builder-3.6.1}/src/oapi_profile_builder/cover.py

@@ -197,17 +197,20 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
     if m and m.doc_number:
         y = centered(m.doc_number, fonts.regular_font(46, bold=True), y, fg) + 40
 
-    # --- Edition ---
+    # --- Edition & date ---
+    # Per DGIWG feedback these two lines are both bold and set a little smaller
+    # than the document number so they read as a compact sub-heading.
+    ed_date_fs = getattr(cover, "edition_date_font_size", 24)
+    bold_ed = bool(getattr(cover, "bold_edition", False))
+
     edition = getattr(profile, "version", None)
     if edition:
-        bold_ed = bool(getattr(cover, "bold_edition", False))
-        y = centered(f"Edition {edition}", fonts.regular_font(28, bold=bold_ed), y, fg) + 24
+        y = centered(f"Edition {edition}", fonts.regular_font(ed_date_fs, bold=bold_ed), y, fg) + 20
 
-    # --- Date ---
     pub_date = (m.doc_pub_date or m.publication_date) if m else None
     date_str = _format_date(pub_date)
     if date_str:
-        y = centered(f"Dated {date_str}", fonts.regular_font(28), y, fg) + 80
+        y = centered(f"Dated {date_str}", fonts.regular_font(ed_date_fs, bold=bold_ed), y, fg) + 80
 
     # --- Title (large, bold, wrapped) ---
     title = getattr(profile, "title", "") or ""

{oapi_profile_builder-3.5.0 → oapi_profile_builder-3.6.1}/src/oapi_profile_builder/generate.py

@@ -1405,13 +1405,16 @@ def build_asyncapi(profile: ServiceProfile) -> dict:
             }
         }
 
-    # Build servers: default production + additional servers
-    servers = {
-        "production": {
+    # Build servers. When the profile lists explicit servers, use those
+    # verbatim so it can describe its exact transport topology (WebSocket /ws,
+    # AMQP 1.0, MQTT, ...). Otherwise synthesise a single implicit production
+    # server from broker_host/broker_port/protocol.
+    servers: dict = {}
+    if not pub.servers:
+        servers["production"] = {
             "host": f"{pub.broker_host}:{pub.broker_port}",
             "protocol": pub.protocol,
         }
-    }
     for srv in pub.servers:
         server_def = {
             "description": srv.description,
@@ -1419,8 +1422,6 @@ def build_asyncapi(profile: ServiceProfile) -> dict:
             "protocol": srv.protocol,
             "security": [],
         }
-        if srv.port:
-            server_def["variables"] = {"port": {"default": str(srv.port), "enum": [str(srv.port)]}}
         if srv.pathname:
             server_def["pathname"] = srv.pathname
         servers[srv.name] = server_def

{oapi_profile_builder-3.5.0 → oapi_profile_builder-3.6.1}/src/oapi_profile_builder/models.py

@@ -526,7 +526,14 @@ class CoverPage(BaseModel):
     logo_y: int = Field(default=180, description="Logo y-offset from top of cover page")
     tagline_font_size: int = Field(default=30, description="Font size of cover page tagline")
     title_font_size: int = Field(default=54, description="Font size of cover page title")
-    bold_edition: bool = Field(default=False, description="When true, render edition in bold font")
+    edition_date_font_size: int = Field(
+        default=24,
+        description="Font size of the cover page edition and date lines (rendered a little smaller than the doc number)",
+    )
+    bold_edition: bool = Field(
+        default=False,
+        description="When true, render both the edition and date lines in bold font",
+    )
 
     @field_validator("background", "text_color")
     @classmethod
@@ -747,12 +754,18 @@ class DocumentMetadata(BaseModel):
 
 
 class PubSubServer(BaseModel):
-    """A single pub/sub server endpoint."""
+    """A single pub/sub server endpoint.
+
+    ``protocol`` accepts the AsyncAPI protocol identifiers used by the EDR
+    Part 2 PubSub bindings: ``amqp`` (AMQP 0-9-1), ``amqp1`` (AMQP 1.0, e.g.
+    RabbitMQ 4.x native AMQP 1.0), ``mqtt``, ``kafka``, and the WebSocket
+    transports ``ws`` / ``wss``.
+    """
     name: str
     description: str = ""
     host: str
     port: int | None = None
-    protocol: Literal["amqp", "mqtt", "kafka", "ws", "wss"] = "amqp"
+    protocol: Literal["amqp", "amqp1", "mqtt", "kafka", "ws", "wss"] = "amqp"
     pathname: str | None = None
 
 
@@ -762,13 +775,22 @@ class CollectionPubSub(BaseModel):
 
 
 class PubSubConfig(BaseModel):
-    """Optional OGC API - EDR Part 2 (PubSub) configuration."""
+    """Optional OGC API - EDR Part 2 (PubSub) configuration.
+
+    When ``servers`` is populated the generated AsyncAPI uses those entries
+    verbatim (keyed by ``name``) and does not synthesise the implicit
+    ``broker_host``/``broker_port`` ``production`` server, letting a profile
+    describe its exact transport topology (e.g. a native WebSocket ``/ws``
+    endpoint plus AMQP 1.0 and MQTT brokers). When ``servers`` is empty the
+    generator falls back to emitting a single ``production`` server built from
+    ``broker_host``/``broker_port``/``protocol``.
+    """
     broker_host: str = "localhost"
     broker_port: int = Field(default=5672, ge=1, le=65535)
-    protocol: Literal["amqp", "mqtt", "kafka"] = "amqp"
+    protocol: Literal["amqp", "amqp1", "mqtt", "kafka"] = "amqp"
     collections: list[str] = Field(default_factory=list, description="Collection IDs that support PubSub")
     filters: list[SubscriptionFilter] = Field(default_factory=list)
-    servers: list[PubSubServer] = Field(default_factory=list, description="Additional server endpoints (ws, wss)")
+    servers: list[PubSubServer] = Field(default_factory=list, description="Server endpoints (ws, wss, amqp, amqp1, mqtt); when set, replaces the implicit production server")
     collection_filters: dict[str, CollectionPubSub] = Field(default_factory=dict, description="Per-collection filter overrides")
 
 

{oapi_profile_builder-3.5.0 → oapi_profile_builder-3.6.1/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.5.0
+Version: 3.6.1
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -181,6 +181,20 @@ OGC API - EDR CITE Results
 
 ## GitHub Actions
 
+### Self-service: generate artifacts from an issue (no fork, no install)
+
+Anyone with a GitHub account can generate artifacts from their own config without cloning or installing anything:
+
+1. Open a new issue using the **"Generate profile artifacts"** template ([New issue](../../issues/new/choose)).
+2. Paste your profile YAML into the config field and submit.
+3. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days). Optionally tick "Compile a PDF?" to also get a Metanorma PDF.
+
+The workflow only runs the generator over your declarative config — it never executes user-supplied code — and comments back on both success and failure. Don't paste secrets: the artifacts are attached to a public workflow run.
+
+> Maintainers: create a `profile-request` label so requests are easy to filter (the workflow gates on a marker in the issue body, so it works even before the label exists).
+
+### Use the action in your own workflow
+
 No local install needed. Add this to any workflow to generate profile artifacts from a config file:
 
 ```yaml
@@ -239,7 +253,7 @@ Everything about the document — cover, title-page metadata, legal page, footer
 | PDF colours (titles, tables, cover, backgrounds) | `document_metadata.colors` | `:presentation-metadata-color-*:` |
 | Page-ii legal text (copyright / license / notice) | `document_metadata.boilerplate` | `:boilerplate-authority:` |
 | Footer organisation name | `document_metadata.copyright_holder` | `:copyright-holder:` |
-| Cover layout (logo size/position, tagline/title size, bold edition) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, bold_edition}` | Generated cover image |
+| Cover layout (logo size/position, tagline/title/edition-date size, bold edition+date) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, edition_date_font_size, bold_edition}` | Generated cover image |
 | Cover date | `document_metadata.doc_pub_date` | Long-format date on the generated cover + `:published-date:` |
 | Remove the OGC logo from the legal page | `document_metadata.suppress_flavor_logo` | targeted `:pdf-stylesheet-override:` |
 | Remove OGC design (crossing lines, circled numbers, rules, navy divider pages) | `document_metadata.suppress_design_elements` (or the individual `suppress_crossing_lines` / `plain_section_numbers` / `suppress_title_underlines`) | `:pdf-stylesheet-override:` + colour attributes |
@@ -695,7 +709,7 @@ When present, generates `asyncapi.yaml` alongside `openapi.yaml`.
 pubsub:
   broker_host: my-broker.example.com
   broker_port: 5672
-  protocol: amqp          # amqp | mqtt | kafka
+  protocol: amqp          # amqp | amqp1 | mqtt | kafka
   collections:
     - my_collection
   filters:
@@ -704,6 +718,40 @@ pubsub:
       type: string
 ```
 
+`broker_host`/`broker_port`/`protocol` synthesise a single implicit
+`production` AsyncAPI server. To describe an exact transport topology instead —
+e.g. a native WebSocket `/ws` endpoint plus AMQP 1.0 and MQTT brokers, as the
+`nws_connect_profile.yaml` example does — list them explicitly under `servers`.
+When `servers` is set, the implicit `production` server is **not** emitted:
+
+```yaml
+pubsub:
+  broker_host: edr-broker
+  broker_port: 5672
+  protocol: amqp1         # AMQP 1.0 (e.g. RabbitMQ 4.x native)
+  collections: [water_gauge, wwa]
+  servers:
+    - name: websocket_secure
+      description: Native WebSocket live map (production)
+      host: ''
+      protocol: wss       # amqp | amqp1 | mqtt | kafka | ws | wss
+      pathname: /ws
+    - name: amqp
+      description: AMQP 1.0 broker (RabbitMQ 4.x native AMQP 1.0)
+      host: 'edr-broker:5672'
+      protocol: amqp1
+    - name: mqtt
+      description: MQTT broker (RabbitMQ MQTT plugin)
+      host: 'edr-broker:1883'
+      protocol: mqtt
+  collection_filters:     # per-collection filter overrides
+    water_gauge:
+      filters:
+        - name: flood_stages
+          description: Alert for selected flood stages
+          type: array
+```
+
 ---
 
 ### `document_metadata`
@@ -773,11 +821,12 @@ document_metadata:
     font_italic: "Source Sans Pro"  # optional italic face for the tagline
     watermark: "DRAFT"             # optional diagonal watermark stamped on the cover
     # --- cover layout (all optional) ---
-    logo_width: 200                # target logo width in px (default 420)
+    logo_width: 300                # target logo width in px (default 420)
     logo_y: 100                    # logo vertical offset from top in px (default 180)
     tagline_font_size: 20          # tagline point size (default 30)
     title_font_size: 40            # title point size (default 54)
-    bold_edition: true             # render the "Edition X" line in bold (default false)
+    edition_date_font_size: 22     # edition/date point size (default 24)
+    bold_edition: true             # render the "Edition X" and "Dated ..." lines in bold (default false)
   colors:
     text: "#000000"                # body text
     cover_text: "#1F3864"          # cover text / section numbers / ToC