ocsf-semtools 0.1.0a4__tar.gz

ocsf_semtools-0.1.0a4/.gitignore

@@ -0,0 +1,20 @@
+# build outputs: compiled schemas, schema checkouts, generated dists, wheels
+build/
+dist/
+*.egg-info/
+
+# written by hatch-vcs at build time
+src/ocsf_semtools/_version.py
+
+# environments and caches
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.import_linter_cache/
+.coverage
+.coverage.*
+htmlcov/
+.DS_Store

ocsf_semtools-0.1.0a4/.importlinter

@@ -0,0 +1,46 @@
+# Import contracts: the core layering, the msgspec boundary, and no imports of generated packages.
+# (A `forbidden` contract errors on a missing source module, so per-module rules are expressed
+# as layers or anchored on the root package.)
+
+[importlinter]
+root_package = ocsf_semtools
+include_external_packages = True
+
+# ir <- loader/export <- schema <- walk <- derive/conform/observables <- engine <- models,
+# with codegen and diff beside walk: they may use schema and below, nothing above, not each other.
+# cli is the outermost layer; nothing in core imports it.
+[importlinter:contract:layers]
+name = Core layering (codegen and diff depend on schema only)
+type = layers
+containers = ocsf_semtools
+layers =
+    cli
+    models
+    engine
+    derive | conform | observables
+    walk | codegen | diff
+    schema
+    loader | export
+    ir
+
+# Architecture rule 2 also allows codegen to import msgspec; it has no need to, so this is stricter.
+[importlinter:contract:msgspec-boundary]
+name = Only models imports msgspec
+type = forbidden
+source_modules =
+    ocsf_semtools
+forbidden_modules =
+    msgspec
+allow_indirect_imports = True
+ignore_imports =
+    ocsf_semtools.models -> msgspec
+
+[importlinter:contract:no-generated-packages]
+name = Nothing in ocsf_semtools imports a generated version package (ocsf_semtools_v*)
+type = forbidden
+source_modules =
+    ocsf_semtools
+forbidden_modules =
+    ocsf_semtools_v1_7_0
+    ocsf_semtools_v1_8_0
+    ocsf_semtools_v1_9_0

ocsf_semtools-0.1.0a4/CHANGELOG.md

@@ -0,0 +1,106 @@
+# Changelog
+
+The library follows SemVer on its own API; before 1.0, a minor release may change it. OCSF schema
+versions are data, so support for a new OCSF version ships as a minor release. Each change gets a
+line here, written for users, in the commit that makes it.
+
+## Unreleased
+
+### Changed
+
+- The project is now ocsf-semtools: `pip install ocsf-semtools`, `import ocsf_semtools`, the
+  `ocsf-semtools` command, and model packages such as `ocsf-semtools-v1-9-0`. Releases up to 0.1.0a3
+  were published as `ocsf-toolkit`, a name the Go project `ocsf/ocsf-toolkit` also uses.
+
+## 0.1.0a3 (2026-11-07)
+
+The model packages are unchanged: their releases on PyPI run on this core.
+
+### Changed
+
+- The command line exits 2 when a command can't do its job: a usage error, a missing file, an unknown version, profile or class, or a failed pipeline gate. Exit 1 now means only that `check` found an error or `diff` a difference.
+- `parse` and `repair` read extensions from `metadata.extensions`, so an event of an extension class
+  such as `win/prefetch_query` is checked against that class; before, it was checked as `base_event`.
+  Both also take `schema=`, a schema from `load()` or `resolve()`, for custom extensions.
+- Conformance enforces numbers as OCSF defines them: NaN and the infinities are a `type_mismatch` for
+  `float_t`, and `integer_t` and `long_t` values must fit in a signed 64-bit integer. An event that
+  passed before may now report these errors.
+- An object an event holds twice, through a cycle or under two paths, is a `repeated_node` error and
+  is walked once. Every run stops after `max_nodes` attribute visits, 100,000 by default; `parse`,
+  `repair` and `extract` take `max_nodes=`, and `None` walks everything.
+- An event that is not a dict raises `TypeError`; a malformed `(schema, class key)` reference is a
+  `TypeError`, and an unknown `class_key` is a `KeyError` naming the schema.
+- `load_ir` reads a `str` as a path, and refuses NaN, infinity, an enum on a non-scalar type and a
+  table of the wrong kind. `resolve` refuses an IR with no `base_event`, an item in the wrong table,
+  an attribute naming a missing object, or non-integer `type_uid` keys. Each is a `ValueError` naming
+  the key path.
+- Enum values in `enum_out_of_range` messages and in `expected` are listed in numeric order.
+- `Report.to_dict()` always returns valid JSON, writing non-finite values as strings.
+- A diff lists a renamed class once, without a separate change to its `key`, and sorts integer keys
+  numerically.
+- Every package carries a NOTICE with the OCSF schema's attribution. Package metadata says Alpha and
+  links the documentation and issue tracker.
+- Releases build with a pinned backend (`packaging/build-requirements.txt`), so a tag rebuilds to its
+  published hashes, and a release requires a passing CI run on the tagged commit.
+
+### Added
+
+- `RepairAction` (the type of `Finding.repair`), `export_ir`, and `ConformanceError.fatal`, the
+  findings that stopped a build.
+- `ResolvedItem.inactive`: the attributes that only inactive profiles add.
+- `ResolvedSchema`, `Report` and `ConformanceError` can be pickled, so they cross process boundaries.
+
+### Removed
+
+- `Policy`, `STRICT`, `LENIENT` and `REPAIR` from the public API. No function accepted them;
+  [Building and checking events](docs/events.md) says what each entry point changes.
+
+### Fixed
+
+- `build()` and `parse(as_=...)` raised `AttributeError` for a model package generated inside another package (such as `myapp.acme_models`); they find the package root wherever it is nested, and a package regenerated in the same process is read again.
+- A missing `git` or `uv` was reported as `[Errno 2] No such file or directory`; the error now says what to install, or to pass `--compiler-cmd`, and a broken cached checkout says to delete it.
+- `generate()` accepted a class or enum named `Literal`, `Struct`, `IntEnum`, `StrEnum` or `Any`, which shadowed the module's import and broke it at import time; such names are refused.
+- `ocsf-toolkit generate --ext` needed `ocsf.lock` in the current directory, which only a checkout of this repository has; it takes the pin from the shipped IR when there is none. An extension's hash leaves out hidden files such as `.git`, so a git operation no longer changes it.
+- Generated code was not ruff-format stable for a required field whose line passed the width, which only long custom names reach; `generate()` now also refuses class, enum and field names over 100 characters, so every line can wrap.
+- `generate()` lost the package it was replacing when both the swap and the restore failed; it now keeps it and names where it is.
+- `build()` and `parse(as_=...)` on a superset model class raised `msgspec.ValidationError` for a
+  wrong-typed attribute of an inactive profile. Such values are checked now, and objects under them
+  walked.
+- Events nested deeper than Python's recursion limit raised `RecursionError` from `build` and
+  `repair`, and an event holding a cycle made `parse` and `repair` hang.
+- `type_uid` was derived from an `activity_id` the class doesn't define, so `activity_id=-1` produced
+  a plausible `type_uid` such as 400099.
+- Observables were read before coercion, so `repair` reported a caller entry for a coerced value as
+  unfounded.
+- A deprecated value moved into a successor present as null was never checked.
+- `repair` reported unknown attributes instead of relocating them when the event had `unmapped: null`.
+- `Report.by_kind("filled")` returned nothing; it matches a `Kind` or its name.
+- A timezone-aware `datetime` with no UTC instant, such as year 1 at +01:00, raised `OverflowError`,
+  and an integer too long to print raised `ValueError` from a message.
+
+## 0.1.0a2 (2026-11-06)
+
+- Publishes the model package `ocsf-toolkit-v1-9-0`.
+
+## 0.1.0a1 (2026-11-06)
+
+The first alpha, with the model packages `ocsf-toolkit-v1-7-0` and `ocsf-toolkit-v1-8-0`.
+
+- Every OCSF release from 1.0.0 to 1.9.0 ships as data. `load()` resolves a version under a set of
+  profiles and extensions into a `ResolvedSchema`: classes, objects, attribute requirements, enums,
+  sibling pairs, class identity and observable markers, with no model needed.
+- `build()` constructs a conformant event and derives what the schema computes: class identity,
+  `type_uid`, sibling labels, `*_dt` timestamps and `metadata.version`. It raises one exception,
+  `ConformanceError`, carrying the full report.
+- `parse()` checks an event and reports every deviation as a `Finding` in a `Report`; `repair()`
+  returns a normalized copy, with every change recorded as a finding.
+- `extract()` and `merge()` derive an event's observables from the schema and check the ones it
+  already lists.
+- `diff()` compares two OCSF versions or IRs, matching classes by uid so a renamed class shows as a
+  rename.
+- `generate()` writes a typed package of msgspec Structs for any version or IR, including one with
+  your own extensions; `build()` and `parse()` take and return its classes.
+- The `ocsf-toolkit` command line: `check`, `diff` (with `--json` and `--semver`), `generate`, and the
+  schema pipeline commands that maintain `ocsf.lock` and the shipped IRs.
+- Releases are reproducible, publish to PyPI through trusted publishing, and attach `ocsf.lock` and
+  `SHA256SUMS` to a GitHub release.

ocsf_semtools-0.1.0a4/CONTRIBUTING.md

@@ -0,0 +1,129 @@
+# Contributing
+
+## Reporting a problem
+
+Open an [issue](https://github.com/k4otix/ocsf-semtools/issues/new/choose). For a wrong finding or a
+missed one, the bug template asks for what reproduces it: the OCSF version, the event (trimmed to
+what matters) and `ocsf-semtools --version`. Report a security problem privately, as
+[SECURITY.md](SECURITY.md) describes.
+
+## Setup
+
+Requires [uv](https://docs.astral.sh/uv/) and git. The library runs on Python 3.12 or newer.
+Compiling an OCSF schema needs Python 3.14, because `ocsf-schema-compiler` does; `uv` fetches it for
+that step, so you don't need to install it yourself.
+
+```shell
+make setup           # uv sync: the dev environment in .venv
+make format          # ruff format and ruff check --fix
+make lint            # ruff format --check, ruff check, lint-imports
+make type            # pyright in strict mode (blocking), mypy --strict (informational)
+make test            # pytest, including the doctests in README.md and docs/
+```
+
+`uvx pre-commit install` runs the blocking lint and type checks on every commit
+(`.pre-commit-config.yaml`).
+
+The schema pipeline and the model packages have their own targets:
+
+```shell
+make schema          # compile every lockfile schema and check every shipped IR against it
+make ir VERSION=...  # rewrite data/ir-<version>.json; RECORD=1 accepts a new IR hash
+make lock VERSION=...  # pin a new OCSF version (see below)
+make generate OCSF=x.y.z  # one model package, in build/dists/
+make dists           # every model-window package, then the regeneration check
+make wheels          # core and model sdists and wheels in build/wheels/ (a new directory), each wheel checked
+make test-generated  # pyright, the snapshot, laziness and a clean install over the built packages
+make compat          # the model packages on PyPI run on this core (LOCAL=1: the ones just built)
+make bench           # engine throughput, on this machine; not part of CI
+make version         # the version hatch-vcs derives, with the pinned build backend
+make clean           # remove build/ and the tool caches
+make help            # every target, with what it does
+```
+
+## Rules that bind code
+
+These architecture rules bind the code, and a PR that needs to break one argues for it in its
+description:
+
+- One traversal of an event, `walk()`; derivation, conformance and observables are visitors on it.
+- The import direction that `.importlinter` enforces: `ir` ← `loader`/`export` ← `schema` ← `walk` ←
+  `derive`/`conform`/`observables` ← `engine` ← `models`, with `codegen` and `diff` on `schema` alone.
+- One exception type, `ConformanceError`; everything else is a builtin exception.
+- No `__getattr__` in the library itself; lazy loading lives only in generated packages.
+- Thin entry points: `build`, `parse` and `repair` each choose a policy, run the engine and convert.
+- Thirteen core modules: `ir`, `loader`, `export`, `schema`, `walk`, `derive`, `conform`,
+  `observables`, `engine`, `diff`, `models`, `codegen` and `cli`.
+- A query surface of read-only mappings, plus the few methods that compute something.
+
+Conventions:
+
+- No runtime dependencies besides `msgspec`. The CLI uses `argparse`.
+- Each module's docstring states its single responsibility in one sentence.
+- Lines are at most 120 characters; ruff format sets the layout.
+- Every public module, class and function has a docstring whose first line is an imperative
+  summary (pydocstyle, pep257 convention). Tests are exempt.
+- Docs and comments say what something is and does.
+
+## Pull requests
+
+- `main` is protected: a PR needs the CI checks to pass and is squash-merged.
+- Plain commit messages; no conventional-commits prefixes.
+- A change users would notice gets a line in `CHANGELOG.md` under Unreleased, in the same PR.
+- Changing `ocsf.lock`, the loader or the shipped IRs runs the schema workflow too.
+- A compiler bump records its new hashes in the same PR, as [Bumping the compiler](#bumping-the-compiler)
+  describes.
+
+## Adding an OCSF version
+
+A new OCSF release ships as a minor release of the library, with a model package for it.
+
+1. Pin it, ship its IR and move the model window:
+
+   ```shell
+   make lock VERSION=x.y.z      # REF=<branch or tag> if the tag isn't x.y.z or vx.y.z
+   ```
+
+   This resolves the upstream tag (`x.y.z`, then `vx.y.z`), pins its commit, compiles it, records
+   `compiled_sha256`, exports the IR with its `ir_sha256`, and records `models_tree_sha256` for the
+   newest three versions. The compile fails if the compiled schema's `version` isn't `x.y.z`: tag
+   `1.5.0` upstream is one such case, so pin the branch with `REF=v1.5.0`. If a step fails, fix the
+   cause and run `make lock` again; a version already pinned at the same commit is kept.
+2. Add the new package, `ocsf_semtools_vX_Y_Z`, to `forbidden_modules` in `.importlinter`; a test
+   fails until you do.
+3. Update the package table in `docs/models.md`.
+4. Set up publishing for the new package, once:
+   - on PyPI, a pending trusted publisher for project `ocsf-semtools-vX-Y-Z`, repository
+     `k4otix/ocsf-semtools`, workflow `release.yaml`, environment `pypi-vX-Y-Z`;
+   - on GitHub, the environment `pypi-vX-Y-Z`, limited to `v*` tags like the others.
+
+   PyPI allows three pending publishers per account. While none is free, add `X.Y.Z` to the
+   repository variable `RELEASE_HOLD_DISTS`: the release builds and checks that package without
+   publishing it, and the next release after you clear the variable publishes it.
+5. The package that leaves the window gets no further releases and stays on the core minor it last
+   required; [Typed models](docs/models.md) tells its users their options. Note it in the
+   changelog.
+
+## Bumping the compiler
+
+The compiler version in `[toolchain]` in `ocsf.lock` is part of every IR's provenance, so a bump
+changes every hash:
+
+```shell
+uv run ocsf-semtools compile --record    # every compiled_sha256
+make ir RECORD=1                         # every ir_sha256 and data/ir-*.json
+uv run ocsf-semtools models record        # every models_tree_sha256
+```
+
+Review the IR diffs (`ocsf-semtools diff OLD.json NEW.json`), since a compiler change can change the
+schema itself. The next release republishes every model package in the window, as their trees
+changed.
+
+## Releasing
+
+1. Run the release workflow by hand (Actions, release, Run workflow) on `main` as a dry run: it runs
+   every gate and builds every package twice, and publishes nothing.
+2. Tag the commit and push the tag: `git tag -s vX.Y.Z -m "ocsf-semtools X.Y.Z" && git push origin vX.Y.Z`.
+   The release needs a passing CI run on that commit.
+3. Approve the `release` environment when the workflow asks. It publishes the core and each model
+   package PyPI lacks, and attaches `ocsf.lock` and `SHA256SUMS` to a GitHub release.

ocsf_semtools-0.1.0a4/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

ocsf_semtools-0.1.0a4/Makefile

@@ -0,0 +1,114 @@
+.PHONY: help setup format lint type test bench schema ir lock version generate dists wheels compat test-generated clean
+
+UV ?= uv
+
+# list the targets, each with the first line of its comment
+help:
+	@awk '/^# / { if (!c) c = substr($$0, 3); next } /^[a-z][a-z-]*:/ { n = $$1; sub(/:.*/, "", n); \
+		if (c) printf "  %-15s %s\n", n, c } { c = "" }' $(firstword $(MAKEFILE_LIST))
+
+# create the dev environment in .venv
+setup:
+	$(UV) sync
+
+# rewrite the code the way ruff formats and fixes it
+format:
+	$(UV) run ruff format .
+	$(UV) run ruff check --fix .
+
+# ruff format --check, ruff check, and the import contracts
+lint:
+	$(UV) run ruff format --check .
+	$(UV) run ruff check .
+	$(UV) run lint-imports
+
+# pyright strict, the blocking gate, then mypy strict, informational
+type:
+	$(UV) run pyright
+	-$(UV) run mypy
+
+# the test suite, in random order, with the doctests in README.md and docs/
+test:
+	$(UV) run pytest
+
+# engine throughput at 2-20 KB per event, on this machine; slow, so not part of `test` or CI
+bench:
+	$(UV) run python -m tests.bench.engine
+
+# gates 1 and 2: compile every lockfile schema, then check every committed IR against it
+schema:
+	$(UV) run ocsf-semtools compile
+	$(UV) run ocsf-semtools ir check
+
+# rewrite data/ir-<ver>.json for VERSION (default: every entry with an ir_sha256); RECORD=1 accepts a new IR
+ir:
+	$(UV) run ocsf-semtools ir export $(VERSION) $(if $(RECORD),--record)
+
+# pin a new OCSF version, ship its IR and move the model window; safe to rerun after a failure
+# (REF= pins a branch or tag of another name)
+lock:
+	@test -n "$(VERSION)" || { echo "usage: make lock VERSION=x.y.z"; exit 2; }
+	$(UV) run ocsf-semtools lock --add $(VERSION) $(if $(REF),--ref $(REF))
+	$(UV) run ocsf-semtools ir export $(VERSION) --record
+	$(UV) run ocsf-semtools models record
+
+# The model dist for one OCSF version as an installable project in build/dists/<package>/.
+# Nothing here deletes: `generate` replaces <package>/ only if every file in it is generated,
+# and the rendered project files are overwritten by name. The dist requires the core version
+# building it, up to its next minor release.
+OCSF ?= 1.9.0
+PACKAGE = ocsf_semtools_v$(subst .,_,$(OCSF))
+DIST = build/dists/$(PACKAGE)
+# the model-window versions, from the one rule that defines them (cli/lock.py)
+WINDOW = $(shell $(UV) run python -c 'from pathlib import Path; from ocsf_semtools.cli import lock; \
+	print(*lock.window(lock.read(Path("ocsf.lock"))))')
+WHEELS = build/wheels
+# Sdists and wheels carry this timestamp and the version of the backend that built them, so a commit
+# rebuilt with the pinned backend gives identical bytes.
+export SOURCE_DATE_EPOCH ?= $(shell git log -1 --format=%ct)
+BUILD_CONSTRAINTS = packaging/build-requirements.txt
+export UV_BUILD_CONSTRAINT := $(CURDIR)/$(BUILD_CONSTRAINTS)
+VERSION_CMD = $(UV) tool run --quiet --constraints $(BUILD_CONSTRAINTS) --with hatch-vcs hatchling version
+
+# the version hatch-vcs derives from git, with the pinned backend
+version:
+	@$(VERSION_CMD)
+
+# one model dist, OCSF=x.y.z (default 1.9.0), in build/dists/
+generate:
+	@echo "$(OCSF)" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$$' || { echo "OCSF must be x.y.z"; exit 2; }
+	mkdir -p $(DIST)
+	$(UV) run ocsf-semtools generate $(OCSF) --package $(PACKAGE) --out $(DIST)
+	version=$$($(VERSION_CMD)) && \
+	$(UV) run python packaging/version_dist/dist.py render --ocsf $(OCSF) --version "$$version" \
+		--out $(DIST)
+
+# every model-window dist, then regeneration gate 3 over the trees on disk
+dists:
+	for v in $(WINDOW); do $(MAKE) --no-print-directory generate OCSF=$$v || exit 1; done
+	$(UV) run ocsf-semtools models check
+
+# core and every model-window dist as sdist and wheel in build/wheels/, each wheel checked
+# (WHEELS must not exist yet: wheels left from an earlier commit would be checked too)
+wheels: dists
+	@test ! -e $(WHEELS) || { echo "$(WHEELS) exists; run make clean, or pass WHEELS=<new dir>"; exit 2; }
+	$(UV) build --quiet --out-dir $(WHEELS)
+	for v in $(WINDOW); do \
+		$(UV) build --quiet --out-dir $(WHEELS) build/dists/ocsf_semtools_v$$(echo $$v | tr . _) \
+			|| exit 1; \
+	done
+	$(UV) run python packaging/version_dist/dist.py check-wheels $(WHEELS)/*.whl
+
+# the released model dists (LOCAL=1: the wheels in build/wheels) run on the core in this checkout
+compat:
+	version=$$($(VERSION_CMD)) && \
+	$(UV) run python packaging/version_dist/dist.py compat --version "$$version" \
+		$(if $(LOCAL),--wheels $(WHEELS))
+
+# static analysis, snapshot, laziness and a clean-environment install of the generated dist
+test-generated:
+	$(UV) run pytest tests/generated
+
+# remove build/ and the tool caches
+clean:
+	rm -rf build dist .pytest_cache .ruff_cache .mypy_cache .import_linter_cache

ocsf_semtools-0.1.0a4/NOTICE

@@ -0,0 +1,19 @@
+ocsf-semtools
+Copyright 2026 Eddie Allan
+
+This product bundles schema data compiled from the Open Cybersecurity Schema Framework (OCSF)
+schema, https://github.com/ocsf/ocsf-schema, and its model packages are generated from that data.
+The OCSF schema is licensed under the Apache License, Version 2.0, and carries this notice:
+
+    Open Cybersecurity Schema Framework
+
+    Copyright © OCSF a Series of LF Projects, LLC
+    For web site terms of use, trademark policy and other project policies please see https://lfprojects.org.
+
+    This project includes the ICD Schema developed by Symantec, a division of Broadcom.
+
+    Licensed under the Apache 2 license.
+    Refer to the Apache 2 license in the file LICENSE.
+
+ocsf-semtools is an independent project. It is not affiliated with or endorsed by OCSF or
+LF Projects, LLC.