xlr8 0.1.7b3__cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

xlr8-0.1.7b3.dist-info/METADATA

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: xlr8
+Version: 0.1.7b3
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Database
+Requires-Dist: pyarrow>14.0.1
+Requires-Dist: pymongo[srv]>3.12.0
+Requires-Dist: pandas>1.5.0
+Requires-Dist: polars>0.15.1
+Requires-Dist: duckdb>0.6.0
+Requires-Dist: orjson>3.8.1
+Requires-Dist: psutil
+Requires-Dist: python-dotenv
+License-File: LICENSE
+Summary: High-performance database read acceleration layer for MongoDB. Auto-chunks and parallelizes queries across multiple-workers, streams results to parquet with intelligent caching and memory-bounded execution, option to stream data directly to any data lake. Same PyMongo API but dramatically faster results with RUST backend for CPU-heavy tasks.
+Keywords: mongodb,parquet,pandas,polars,database,acceleration,caching
+Author: Kapil Parekh
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/XLR8-DB/xlr8/main/.github/XLR8_logo.png" alt="XLR8 Logo" width="360"/>
+</p>
+
+<p align="center">
+  <strong>Accelerate MongoDB analytical queries with parallel execution and Parquet caching</strong>
+</p>
+
+<p align="center">
+  <em>Faster Queries → Less Memory → Real Savings</em>
+</p>
+
+<p align="center">
+  <a href="https://github.com/XLR8-DB/xlr8"><img src="https://img.shields.io/badge/GitHub-Repository-blue?logo=github" alt="GitHub"/></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%2B-blue.svg" alt="Python versions"/></a>
+  <a href="https://github.com/XLR8-DB/xlr8/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License"/></a>
+</p>
+
+<p align="center">
+  <strong>🦀 Rust-Backed</strong> · <strong>⚡ Up to 4x Faster Queries</strong> · <strong>📦 10-12x Compression</strong> · <strong>📊 Configurable Memory Limits</strong>
+</p>
+
+---
+
+## Minimal Code Changes
+
+```python
+# Before: PyMongo
+df = pd.DataFrame(list(collection.find(query)))
+
+# After: XLR8 - just wrap and go!
+xlr8_collection = accelerate(collection, schema, mongodb_uri)
+df = xlr8_collection.find(query).to_dataframe()
+```
+
+That's it. Same query syntax, same DataFrame output - just faster.
+
+---
+
+## The Problem
+
+When running analytical queries over large MongoDB collections, you encounter two fundamental bottlenecks:
+
+**I/O Bound**: PyMongo uses a single cursor, fetching documents one batch at a time. Your CPU sits idle waiting for network round trips.
+
+**CPU/GIL Bound**: Even with the data in hand, Python's Global Interpreter Lock (GIL) means BSON decoding and DataFrame construction happen on a single core.
+
+These aren't PyMongo limitations - they're inherent to Python's design. XLR8 provides a solution.
+
+---
+
+## How XLR8 Solves It
+
+XLR8 releases Python's GIL and hands execution to a **Rust backend** powered by Tokio's async runtime:
+
+1. **Query Planning** → Splits your query into time-based chunks
+2. **Parallel Workers** → Multiple workers fetch from MongoDB simultaneously  
+3. **BSON → Arrow** → Direct conversion without Python overhead
+4. **Parquet Caching** → Results cached for instant reuse
+5. **DataFrame Assembly** → Final merge via DuckDB (GIL-free)
+
+The result? Your analytical queries run **significantly faster**, especially for large result sets.
+
+---
+
+## Installation
+
+```bash
+pip install xlr8
+```
+
+XLR8 requires Python 3.11+ and includes pre-compiled Rust extensions for Linux, macOS, and Windows.
+
+---
+
+## Quick Start
+
+```python
+from pymongo import MongoClient
+from xlr8 import accelerate, Schema, Types
+from datetime import datetime, timezone, timedelta
+
+# Connect to MongoDB
+client = MongoClient("mongodb://localhost:27017")
+collection = client["iot"]["sensor_readings"]
+
+# Define your schema
+schema = Schema(
+    time_field="timestamp",
+    fields={
+        "timestamp": Types.Timestamp("ms", tz="UTC"),
+        "device_id": Types.ObjectId(),
+        "reading": Types.Any(),  # Handles int, float, string dynamically
+    },
+    avg_doc_size_bytes=200,
+)
+
+# Wrap collection with XLR8
+xlr8_col = accelerate(collection, schema=schema, mongo_uri="mongodb://localhost:27017")
+
+# Query like normal PyMongo
+cursor = xlr8_col.find({
+    "timestamp": {"$gte": datetime(2024, 1, 1, tzinfo=timezone.utc)}
+}).sort("timestamp", 1)
+
+# Get DataFrame - parallel fetch, cached for reuse
+df = cursor.to_dataframe(
+    chunking_granularity=timedelta(days=7),
+    max_workers=8,
+)
+```
+
+---
+
+## Key Features
+
+| Feature | Description |
+|---------|-------------|
+| 🦀 **GIL-Free Rust Backend** | Python's GIL is released. Rust's Tokio runtime handles async I/O across all cores. |
+| ⚡ **Parallel MongoDB Fetching** | Queries split into time chunks. Each worker has its own MongoDB connection. |
+| 💾 **Smart Query Cache** | Results cached by query hash. Filter cached data by date range. |
+| 🔀 **DuckDB K-Way Merge** | GIL-free sorting across shards - O(N log K) complexity. |
+| 🐻‍❄️ **Pandas & Polars** | `to_dataframe()` for pandas, `to_polars()` for Polars. |
+| 📊 **Memory Control** | Set `flush_ram_limit_mb` to prevent OOM errors on large datasets. |
+| 📤 **Stream to Data Lakes** | `stream_to_callback()` for S3/GCS ingestion pipelines. |
+
+---
+
+## Performance
+
+| Metric | Improvement |
+|--------|-------------|
+| Query Speed | Up to **4x faster** on large result sets |
+| Compression | **10-12x** storage reduction with Parquet |
+| Memory | Configurable limits prevent OOM |
+| Repeat Queries | **Instant** from cache |
+
+---
+
+## Documentation
+
+📖 **Full documentation with architecture diagrams**: [GitHub Repository](https://github.com/XLR8-DB/xlr8)
+
+---
+
+## License
+
+Apache 2.0 - See [LICENSE](https://github.com/XLR8-DB/xlr8/blob/main/LICENSE) for details.
+

xlr8-0.1.7b3.dist-info/RECORD

@@ -0,0 +1,31 @@
+xlr8/__init__.py,sha256=u3m-4VUcfcy-lsTQMz4dnRGctNTHijAxLOuZY53xQjs,3333
+xlr8/_xlr8_rust.cpython-311-aarch64-linux-gnu.so,sha256=7_HgDSpQLXKqu19KAVosCw4bU2dGg-9LKdUYZwgECKs,23647944
+xlr8/_xlr8_rust.pyi,sha256=KNIhhyP2vITNJDq6s3Ct7_VK-hTab8PWCQL16ZqWgCQ,2071
+xlr8/analysis/__init__.py,sha256=vhi3Q3haxzuhtqsnK2GGxmHtMIUptBEj6ZLmFxWT8d0,1309
+xlr8/analysis/brackets.py,sha256=x7gBOU1T0xrVY00m2MlnJpAS4CGghRFnwdYGDt3AW0A,46737
+xlr8/analysis/chunker.py,sha256=4ozW9rCtJ__njwb9wQ1EIvykmc8B6iYJELvEWmYjhsw,3262
+xlr8/analysis/inspector.py,sha256=bOtzgs5c4t6qqhAcX-cwUe3B81nJU0maUZr5mX8Fm2s,71604
+xlr8/collection/__init__.py,sha256=wHaoS-_QCStNMXsPMxuCwiRHXBu35qL2OoJ-HxHBGjA,200
+xlr8/collection/cursor.py,sha256=u_SG_Y7hc02lWxMKFtG7ZJOx-rGq50FSWZcxHyFXG-Q,92555
+xlr8/collection/cursor.pyi,sha256=1QHVL_nce-p14kht-6rFfBRIfeeMTznH8XtCdaEkpt8,6964
+xlr8/collection/wrapper.py,sha256=qwc6eh7Izw53QwaHSlRtuD1mgnVxQ-oPBI8OcfFlLyE,16550
+xlr8/collection/wrapper.pyi,sha256=bj4Taw1wO9rGUu06xHZQQ-XVzlT_7LpaXha5GDlFth4,14250
+xlr8/constants.py,sha256=n_guEhgxs7fT_ki9-eQqex1TG7n11jtEX-riHq6MVuw,861
+xlr8/execution/__init__.py,sha256=mUbmoU_VdBx_E1kWc-9UZYF2s3wUVnRYxhJkCRtl6IM,1107
+xlr8/execution/callback.py,sha256=TpYTTyrdsb3yfLTiT1bX6oRFEuUHQDsnTQw7gnIIWOQ,28910
+xlr8/execution/executor.py,sha256=Ch9wcqzkOWpV79xnt4qioBQLsFkK9YSmToxjyo90StE,23418
+xlr8/execution/planner.py,sha256=gPLTV6ojXx-iUvkb0qiFV7dMnQQoYV3UAVZPv9HuWNo,13663
+xlr8/py.typed,sha256=cZhjU4bgcfkAJgWW8rlBPwh-6sWO56Oixl8mV1RlwjI,74
+xlr8/rust_backend.py,sha256=7reIfRSPcQhOGCNBYCQTzqZWadcMEegrcrc7pkJm8HA,1095
+xlr8/rust_backend.pyi,sha256=45hT0Bdsm3nlUOwlrewvftImnGjv-gKocllmq4skyWM,2069
+xlr8/schema/__init__.py,sha256=AXtzil3Ze6BNb315karZf-2r_HN8gCDYkzhU3ZkqTCY,675
+xlr8/schema/encoder.py,sha256=7UM_3dW97CCDqmAWHmiw4gV2O-F0PV-ULMlmLO7UA14,10233
+xlr8/schema/schema.py,sha256=fKYj5VXhD4pf86QtdHYruk9OSmYrjB-naQvpQCsPbNc,9177
+xlr8/schema/types.py,sha256=-Ay74u1HjKja2l4gwjzvATm49TEMR31lQ7AxZckYLB0,6640
+xlr8/storage/__init__.py,sha256=ivct_RuRIWyUfsro_i83g0DxwtryPMsGksTjRq2ygT0,392
+xlr8/storage/cache.py,sha256=ehcTjyVQd1yI3-CGyRHOygmQ5MwTz6X2ooAI_Nv9Fx8,6754
+xlr8/storage/reader.py,sha256=xmsH4rwv4gy6kFvZbBzGkTU0uHEiYwr0jBVS6wiaNYY,56436
+xlr8-0.1.7b3.dist-info/METADATA,sha256=QC7GsMXAnFwZALXdaIGSJadpm1ttTVPfJX_Rf8FQFQY,6110
+xlr8-0.1.7b3.dist-info/WHEEL,sha256=g3NYz5uLPCJZB907tjbdQqvMfef9wxu3zDTIVjqNp6A,149
+xlr8-0.1.7b3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+xlr8-0.1.7b3.dist-info/RECORD,,

xlr8-0.1.7b3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: maturin (1.11.5)
+Root-Is-Purelib: false
+Tag: cp311-cp311-manylinux_2_17_aarch64
+Tag: cp311-cp311-manylinux2014_aarch64

xlr8-0.1.7b3.dist-info/licenses/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 [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.