jolt-py 1.0.0__tar.gz

jolt_py-1.0.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+htmlcov/
+.coverage
+coverage.xml
+*.log

jolt_py-1.0.0/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] — 2024-04-10
+
+### Added
+
+**Core transforms (full Java JOLT parity)**
+
+- `Shift` — re-map fields with full spec language support:
+  - Literal key matching
+  - Wildcard `*` matching (prefix/suffix combinable, e.g. `prefix_*_suffix`)
+  - OR patterns (`a|b`)
+  - Self-reference `@` — uses the current input node as its own value
+  - `$` / `$N` — emits the matched key name N levels up as a value
+  - `#literal` — emits a constant string as a value
+  - Output path tokens: `&`/`&N` back-references, `&(N,M)` capture groups,
+    `@(N,path)` value lookups, `[]` array-append
+  - Array-of-objects slot coordination — multiple fields from the same wildcard
+    iteration land in the same output list element
+  - Multiple output paths (list of strings)
+
+- `Default` — fill absent or `null` fields; wildcard `*` applies to every key;
+  list-aware (`{"key": {"*": sub_spec}}` applies `sub_spec` to each list element)
+
+- `Remove` — delete specified fields; `"*"` removes all keys at a level
+
+- `Sort` — recursively sort all dict keys alphabetically
+
+- `Cardinality` — enforce `ONE` (scalar) or `MANY` (list) cardinality
+
+- `ModifyOverwrite` / `ModifyDefault` — apply functions or literal values to
+  fields; 39 built-in functions covering type conversions, string manipulation,
+  numeric operations, and collection utilities:
+  `toInteger`, `toLong`, `toDouble`, `toFloat`, `toString`, `toBoolean`,
+  `trim`, `toUpperCase`, `toLowerCase`, `abs`, `min`, `max`, `intSum`,
+  `doubleSum`, `longSum`, `floatSum`, `sum`, `avg`, `sqrt`, `not`,
+  `size`, `concat`, `join`, `split`, `leftPad`, `rightPad`, `substring`,
+  `startsWith`, `endsWith`, `contains`, `squashNulls`, `recursivelySquashNulls`,
+  `toList`, `firstElement`, `lastElement`, `elementAt`, `indexOf`, `coalesce`,
+  `noop`
+
+- `Chainr` — chain multiple transforms sequentially; supports both direct
+  instantiation and JOLT-spec lists (`from_spec`)
+
+**Packaging**
+
+- PEP 561 `py.typed` marker — full inline type annotations
+- `pyproject.toml` with hatchling build backend, classifiers, URLs
+- Python 3.10–3.13 support
+
+**Tests**
+
+- 193 tests across all transforms and real-world integration scenarios
+
+[1.0.0]: https://github.com/sthitaprajnas/pyjolt/releases/tag/v1.0.0

jolt_py-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to PyJolt
+
+Thank you for your interest in contributing! We welcome bug reports, feature
+requests, and pull requests.
+
+## Development setup
+
+```bash
+git clone https://github.com/sthitaprajnas/pyjolt.git
+cd pyjolt
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Running tests
+
+```bash
+# All tests
+pytest
+
+# With coverage
+pytest --cov=pyjolt --cov-report=term-missing
+
+# Single file
+pytest tests/test_shift.py -v
+```
+
+## Code quality
+
+```bash
+# Lint + auto-fix
+ruff check src/pyjolt --fix
+
+# Type check
+mypy src/pyjolt
+```
+
+Both must pass with zero errors before a PR is merged.
+
+## Submitting a pull request
+
+1. Fork the repository and create a branch from `main`.
+2. Add or update tests that cover your change.
+3. Ensure `pytest`, `ruff check`, and `mypy` all pass.
+4. Open a pull request with a clear description and reference any related issues.
+
+## Reporting issues
+
+Use [GitHub Issues](https://github.com/sthitaprajnas/pyjolt/issues).  For
+security vulnerabilities, see [SECURITY.md](SECURITY.md).
+
+## Coding conventions
+
+- Follow existing code style (enforced by ruff).
+- Full type annotations on all public functions.
+- Docstrings on public classes and methods.
+- No runtime dependencies beyond the Python standard library.
+
+## License
+
+By contributing you agree that your contributions will be licensed under the
+[Apache License 2.0](LICENSE).

jolt_py-1.0.0/LICENSE

@@ -0,0 +1,186 @@
+                                 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 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, as submitted to the 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, "submit" 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 designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 contributions
+      Licensable by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the 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 any
+      Contribution embodied 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as opposed to the original Work.
+
+   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 conditions of TITLE,
+      MERCHANTIBILITY, 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 exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (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 offer only
+      conditions consistent with this License and charge a reasonable fee.
+
+   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 in question.
+
+   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.

jolt_py-1.0.0/NOTICE

@@ -0,0 +1,9 @@
+PyJolt
+Copyright 2024 Sthitaprajna Sahoo and contributors
+
+This product includes software developed at the PyJolt project
+(https://github.com/sthitaprajnas/pyjolt).
+
+This software is a Python implementation inspired by the JOLT library
+(https://github.com/bazaarvoice/jolt), originally developed by Bazaarvoice, Inc.
+and licensed under the Apache License, Version 2.0.