pyrewire 1.0.0__tar.gz

pyrewire-1.0.0/CHANGELOG.md

@@ -0,0 +1,126 @@
+# Changelog
+
+All notable changes to PyreWire are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/). PyreWire and
+wirelog version independently; each PyreWire release declares a runtime
+wirelog floor and a validated wirelog ref (see
+[versioning rule](docs/versioning.md)).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-05-27
+
+### Added
+- PyreWire 1.0.0 is the first stable release of the Python wrapper for
+  wirelog. It establishes the supported public API boundary for the
+  `pyrewire` package and marks v1.0.x as the security-supported release
+  line.
+- Stable top-level exports now include:
+  - incremental session classes: `EasySession` and `Session`;
+  - batch execution classes: `BatchProgram` and `Result`;
+  - program and introspection wrappers: `Program`, `Schema`, `Column`,
+    `Stratum`, and `IRNode`;
+  - async wrappers: `AsyncEasySession`, `AsyncSession`, and
+    `AsyncBatchProgram`;
+  - IO adapter exports: `IOContext`, `register_adapter`,
+    `unregister_adapter`, and `registered_schemes`;
+  - compound wrappers: `Compound` and `CompoundArg`;
+  - exported enums, errors, and helpers, including `ErrorCode`,
+    `ColumnType`, `CompoundKind`, `IRNodeType`, `WirelogError`
+    subclasses, `wirelog_version`, `build_config`, `Delta`, and
+    `make_safe_print_delta`.
+- Incremental session capabilities are validated against wirelog
+  v0.50.0. `EasySession` and `Session` support step/snapshot workflows,
+  and `AsyncSession` provides the async incremental session surface.
+
+### Changed
+- Package metadata is now versioned as `1.0.0` with the
+  `Development Status :: 5 - Production/Stable` classifier.
+- PyreWire follows semantic-versioning expectations for the stable
+  public API. Backward-incompatible changes require a new major version;
+  deprecated public APIs will remain available for at least one minor
+  release before removal unless a security or correctness issue makes
+  that impossible.
+- The README quickstart and `docs/` now describe the v1 public API:
+  `BatchProgram` for one-shot closure and `EasySession` / `Session` for
+  incremental step/snapshot work. The old `Program`-builder examples
+  were replaced with the supported APIs, and the README badges now
+  match the `ci` and `docs` workflows (#122).
+- GitHub release automation extracts this exact tagged changelog section
+  for release notes instead of publishing the full changelog body.
+
+### Support
+- Supported Python versions are CPython 3.11, 3.12, 3.13, and 3.14.
+  Python 3.10 is not supported by the v1.0 release line.
+- Published wheels are built for Linux `manylinux_2_28` `x86_64`,
+  macOS `arm64` only, and Windows `AMD64`.
+- Wheels bundle `libwirelog`, so wheel installs do not require a
+  separate wirelog installation.
+- Source distributions do not bundle `libwirelog`. Source installs need
+  a compatible system `libwirelog` discoverable by the loader, or an
+  explicit `WIRELOG_LIB` path.
+- PyreWire 1.0.0 is validated against wirelog v0.50.0 at peeled SHA
+  `272edf3a24b25676f12c4b843d55510f5048dd2f`; the minimum compatible
+  runtime wirelog version is 0.44.0. This wirelog release includes the
+  recursive aggregation residue fix needed for the stable
+  step/snapshot API.
+- Release, test, and wheel automation runs on `ubuntu-24.04`,
+  `macos-15`, and `windows-2025-vs2026` with Python 3.11-3.14.
+
+## [0.41.0] - 2026-05-21
+
+### Added
+- FFI bootstrap (#2): libwirelog discovery and runtime version
+  verification with `WirelogVersionUnavailableWarning` fallback for
+  pre-#841 builds.
+- Typed exception hierarchy (#4): `WirelogError` and subclasses,
+  `check(rc)` helper, `error_string(rc)` with local fallback table.
+- ctypes types / enums / callbacks (#3) and the shared libc
+  allocator helper (#41).
+- `EasySession` (#9): lifecycle, intern table, `insert` / `remove`,
+  and the variadic `insert_sym` / `remove_sym` wrappers (#44).
+  `set_delta_callback` / `step` / `snapshot` were not part of 0.41.0;
+  they require wirelog#852 and a runtime wirelog `0.44.0` or newer.
+  The later [1.0.0] release is validated against and bundles wirelog
+  v0.50.0.
+- `Session` (advanced, #21): backend selection, worker count,
+  batched `insert` / `remove`, `step`, `snapshot`, `set_delta_callback`,
+  one-way mode machine, NumPy zero-copy `insert_batch` / `remove_batch`
+  (#22), `make_compound` (#23), `seed_intern`.
+- `BatchProgram` + `Result` (#17 / #18): parse → optimize → evaluate,
+  per-relation CSV write, schema-driven row decoding.
+  `BatchProgram.load_all_facts` / `load_input_files` /
+  `optimizer_debug` via the C-level stdout capture (#19).
+- `Program` / `Schema` / `Stratum` (#14) with inline-fact extraction
+  (#15) and `preview_inline_facts` + `insert_with_dedupe` (#47).
+- `IRNode` lazy tree wrapper (#25) layered on the IR FFI bindings (#24).
+- `@register_adapter` decorator for Python-defined IO adapters
+  bridged to wirelog's ABI v2 (#26 + #27).
+- `Compound` wrapper with weakref-based session-scope invalidation
+  (#23); `CompoundBusyError` / `CompoundSaturatedError` surface
+  through `check(rc)`.
+- `AsyncEasySession`, `AsyncSession`, `AsyncBatchProgram` (#29) —
+  asyncio proxies that run every wirelog call on a per-instance
+  single-worker thread.
+- mkdocs-material documentation site with mkdocstrings auto-rendered
+  reference (#34) and a four-page semantics guide (#36).
+- CI: lint gate (black / isort / flake8 / ruff / mypy) → test matrix
+  (Ubuntu 24.04 / macOS-15 / Windows 2025 VS 2026 × py3.11-3.14) → 90 % coverage floor (#38 / #39 / #40).
+- Distribution: MANIFEST.in excludes wirelog binaries from sdists
+  (#51); wheel-bundling matrix and cibuildwheel config tracked in
+  #30 / #31 / #32 / #33.
+
+### Notes
+- This release matches wirelog `v0.41.0`. The wheel bundles
+  `libwirelog.so.1` (or the platform equivalent); no system install
+  is required.
+- Arrow zero-copy interop is **deferred** to a follow-up release.
+  Tracked in #50.
+- `EasySession.step` / `snapshot` and the `step` / `snapshot`
+  mirrors on `AsyncEasySession` are not in 0.41.0 — they require
+  wirelog#852. They are available in the later [1.0.0] line, whose
+  validated wirelog ref is v0.50.0. Tracked in wirelog#859.
+
+[Unreleased]: https://github.com/semantic-reasoning/PyreWire/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/semantic-reasoning/PyreWire/compare/v0.41.0...v1.0.0
+[0.41.0]: https://github.com/semantic-reasoning/PyreWire/releases/tag/v0.41.0

pyrewire-1.0.0/LICENSE

@@ -0,0 +1,13 @@
+PyreWire is dual-licensed under either of
+
+  * Apache License, Version 2.0
+    (see LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
+
+  * GNU General Public License, version 3 or (at your option) any later version
+    (see LICENSE-GPL or https://www.gnu.org/licenses/gpl-3.0.html)
+
+at your option.
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in PyreWire by you shall be dual licensed as above,
+without any additional terms or conditions.

pyrewire-1.0.0/LICENSE-APACHE

@@ -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.