apizit-linking 0.3.0__tar.gz

apizit_linking-0.3.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to APIZIT Linking are documented here.
+
+## 0.3.0 - Public beta
+
+- publish the standalone package with an Apache-2.0 licence;
+- support `pip install "apizit-linking[preview]==0.3.0"`;
+- keep static sibling routes ahead of dynamic routes and reject route patterns
+  whose overlap cannot be ordered safely;
+- isolate customer modules by project while supporting local imports performed
+  during function invocation;
+- resolve valid annotations independently when another annotation contains an
+  unknown forward reference;
+- include the V1 documentation, examples, and complete test support in the
+  source distribution;
+- test Python 3.10 through 3.14 and prepare PyPI Trusted Publishing.
+
+## 0.2.0
+
+- extract the declarative linking engine from the APIZIT platform;
+- add static validation, the standalone CLI, FastAPI adapter, and local preview.

apizit_linking-0.3.0/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 2026 APIZIT contributors
+
+   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.

apizit_linking-0.3.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include CHANGELOG.md
+include LICENSE
+include README.md
+recursive-include docs *.md
+recursive-include examples *.py *.yaml
+recursive-include tests *.py

apizit_linking-0.3.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: apizit-linking
+Version: 0.3.0
+Summary: Standalone declarative Python-to-HTTP binding engine
+Author: APIZIT
+License-Expression: Apache-2.0
+Keywords: api,declarative,fastapi,http,yaml
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.3
+Provides-Extra: fastapi
+Requires-Dist: fastapi<1,>=0.115.0; extra == "fastapi"
+Requires-Dist: python-multipart<1,>=0.0.18; extra == "fastapi"
+Provides-Extra: preview
+Requires-Dist: fastapi<1,>=0.115.0; extra == "preview"
+Requires-Dist: python-multipart<1,>=0.0.18; extra == "preview"
+Requires-Dist: uvicorn<1,>=0.30.0; extra == "preview"
+Dynamic: license-file
+
+# apizit-linking
+
+`apizit-linking` is a standalone declarative Python-to-HTTP binding engine. It
+turns a versioned configuration file into validated HTTP routes while keeping
+customer Python code unchanged. APIZIT is one platform that consumes it, not a
+dependency of the package.
+
+```python
+def create_customer(customer_name: str, age: int):
+    return {"name": customer_name, "age": age}
+```
+
+```yaml
+version: 1
+
+routes:
+  - path: /customers
+    method: POST
+    function: customer_service:create_customer
+    parameters:
+      customer_name:
+        source:
+          location: body
+          name: name
+      age:
+        source:
+          location: body
+          name: age
+```
+
+There are no APIZIT decorators, imports, handlers, or web routes in customer
+code.
+
+## Install the public beta
+
+The core validation and runtime engine requires only PyYAML:
+
+```text
+pip install "apizit-linking==0.3.0"
+```
+
+Install the local FastAPI preview as an optional extra:
+
+```text
+pip install "apizit-linking[preview]==0.3.0"
+apizit-linking validate .
+apizit-linking preview . --port 8080
+```
+
+Version 0.3.0 is a public beta. Pin the exact version in projects and deployment
+artifacts until the compatibility policy is declared stable.
+
+## Validate locally
+
+The command searches the target directory for `apizit_linking.yaml`,
+`apizit_linking.yml`, then `apizit_linking.json`:
+
+```text
+apizit-linking validate .
+apizit-linking validate . --json
+apizit-linking validate path/to/apizit_linking.yaml --project-root .
+```
+
+Validation is static. It parses the customer module with the Python AST and does
+not import or execute customer code.
+
+## Preview locally
+
+```text
+apizit-linking preview . --port 8080
+```
+
+Preview binds to `127.0.0.1` by default. It validates before importing customer
+modules, then executes them in the server process. Binding to a non-loopback
+interface requires `--allow-network`.
+
+The preview server is a development tool, not an authentication layer, a
+production deployment boundary, or a sandbox. Linked customer modules are
+ordinary trusted Python code and may execute arbitrary code when imported or
+called.
+
+## V1 configuration reference
+
+The root document is a closed, versioned object:
+
+```yaml
+version: 1
+runtime:
+  language: python
+  version: "3.12"
+routes:
+  - path: /customers/{customer_id}
+    method: PATCH
+    function: customer_service:update_customer
+```
+
+`function` uses the canonical dotted `module:function` form. `path` must be an
+absolute HTTP path and route placeholders use `{parameter_name}`. Methods are
+normalized to uppercase and must be one of `GET`, `POST`, `PUT`, `PATCH`,
+`DELETE`, `OPTIONS`, or `HEAD`.
+
+The compiler verifies module and function existence, top-level callability,
+supported signatures, parameter bindings, request-source compatibility, and
+route collisions. A static sibling such as `/customers/search` is registered
+before `/customers/{customer_id}` regardless of declaration order. Cross-shaped
+patterns that overlap without a safe specificity order are rejected as
+`ROUTE_AMBIGUITY`.
+
+### Explicit parameter sources
+
+The canonical source syntax is a structured object:
+
+```yaml
+parameters:
+  customer_name:
+    source:
+      location: body
+      name: name
+```
+
+This binds HTTP body field `name` to Python parameter `customer_name`. When a
+source is explicit, only that source is inspected. There is no fallback to
+another source.
+
+V1 supports:
+
+- `path`
+- `query`
+- `header`
+- `body`
+- `form`
+- `file`
+
+Header names are case-insensitive; other external names are exact. A route
+cannot require both a JSON `body` value and a `form` or `file` value because
+those request encodings are incompatible.
+
+### Automatic parameter resolution
+
+If a parameter has no explicit source, V1 searches its Python name in this
+stable order:
+
+```text
+path > query > header > body > form > file
+```
+
+The first present source wins. A required absent parameter produces
+`PARAMETER_NOT_FOUND`; explicit mode produces
+`PARAMETER_NOT_FOUND_IN_SOURCE`. Parameters with Python defaults are omitted
+from the generated keyword arguments so Python applies their defaults.
+
+Missing values, JSON `null`, and empty strings are distinct. `null` is accepted
+only by a nullable annotation. V1 converts primitive `str`, `int`, `float`,
+`bool`, nullable unions, lists, and dictionaries. If one annotation contains an
+unknown forward reference, other resolvable annotations are still converted.
+
+### Stable error shape
+
+Request errors use a JSON object:
+
+```json
+{
+  "error": {
+    "code": "PARAMETER_NOT_FOUND_IN_SOURCE",
+    "message": "Required field 'name' was not found in request source 'body'.",
+    "parameter": "customer_name",
+    "external_name": "name",
+    "source": "body"
+  }
+}
+```
+
+Configuration diagnostics include a stable code, severity, field, route index,
+parameter, and relevant source metadata. The beta does not yet guarantee that
+new minor releases will never add diagnostic codes or metadata fields.
+
+## Python API
+
+Platform adapters compile with `compile_linking_file`, serialize each validated
+`RouteDefinition`, then use `RequestContext`, `resolve_arguments`,
+`load_functions`, and `invoke_function` in the customer runtime. Compilation is
+the static boundary; customer imports happen only through the runtime loader.
+
+The optional ASGI adapter is available without changing customer code:
+
+```python
+from apizit_linking.fastapi import create_app
+
+app = create_app(".")
+```
+
+Platforms may wrap that app with their own server, authentication, metering, or
+deployment layer. FastAPI documentation routes are disabled by default because
+V1 does not yet generate a complete request/response OpenAPI contract; pass
+`docs=True` only when that limitation is acceptable.
+
+## Package scope
+
+The package owns discovery, YAML/YML/JSON parsing, closed V1 validation, safe
+static `module:function` resolution, AST signature inspection, compilation,
+structured diagnostics, request-context resolution, primitive conversion,
+sync/async invocation, and the optional FastAPI preview.
+
+It intentionally does not own Mangum, API Gateway, Lambda, deployment, metering,
+or APIZIT scan UI/reporting. The core installation remains independent of
+FastAPI.
+
+## Development
+
+```text
+git clone https://github.com/chipsi44/apizit-linking.git
+cd apizit-linking
+uv sync --all-extras --all-groups
+uv run python -m unittest discover -s tests -p "test_*.py"
+uv run ruff check src tests
+uv run black --check src tests
+uv build
+```
+
+The complete V1 reference, release procedure, remaining work, examples, and
+tests are included in the source distribution. APIZIT Linking is licensed under
+Apache-2.0.