aerospike-sdk 0.9.0a1__tar.gz

aerospike_sdk-0.9.0a1/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.

aerospike_sdk-0.9.0a1/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.4
+Name: aerospike-sdk
+Version: 0.9.0a1
+Summary: Aerospike Python SDK - a modern, developer-friendly interface for Aerospike
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aerospike-async==0.4.0a1
+Requires-Dist: antlr4-python3-runtime>=4.13.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-env>=1.1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: antlr4-python3-runtime>=4.13.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser>=4.0; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: sphinx-autobuild; extra == "docs"
+Dynamic: license-file
+
+# Aerospike Python SDK
+
+A high-level API on the Aerospike Python Async Client, providing an intuitive and chainable interface for database operations.
+
+> **Status:** Public preview (alpha). Not yet production-ready; feedback welcome via GitHub Issues.
+
+## Prerequisites
+
+- **Python** 3.10 - 3.14 (recommended: [pyenv](https://github.com/pyenv/pyenv) with a dedicated environment for this repo)
+- **Aerospike server** -- required for integration tests
+- **Rust toolchain** (rustc + cargo) -- only needed if building the Aerospike Python Async Client from source
+- **Java 11+** -- required for the one-time AEL parser build (`make generate-ael`)
+
+## Install the Aerospike Python Async Client
+
+This SDK depends on the [Aerospike Python Async Client](https://github.com/aerospike/aerospike-client-python-async),
+published on PyPI as [`aerospike-async`](https://pypi.org/project/aerospike-async/).
+The version is pinned in `pyproject.toml` under `[project] dependencies`. A normal
+`pip install -e ".[dev]"` resolves it from PyPI automatically -- no Rust toolchain
+or git checkout required for ordinary development.
+
+### Local PAC checkout (development against an unreleased PAC tree)
+
+To test against a sibling PAC working tree (e.g. for a feature not yet on PyPI),
+install it editable first and pass `--no-deps` to this SDK so pip doesn't try
+to re-resolve PAC from PyPI:
+
+```bash
+pip install -e /path/to/aerospike-client-python-async
+pip install -e ".[dev]" --no-deps
+```
+
+Or use `requirements-local.txt` (gitignored path example).
+
+## Install this package
+
+Use the interpreter from your pyenv environment (see `.cursor/rules/guiding-principles.mdc` for the usual env name), then:
+
+```bash
+make generate-ael          # one-time: build the ANTLR AEL parser (requires Java 11+)
+pip install -e ".[dev]"
+```
+
+`make generate-ael` only needs to be re-run if `aerospike_sdk/ael/antlr4/Condition.g4` changes.
+
+## Configuration
+
+Copy `aerospike.env.example` to `aerospike.env` in the repo root and adjust hosts or ports. `aerospike.env` is not committed.
+
+```bash
+cp aerospike.env.example aerospike.env
+source aerospike.env
+```
+
+Pytest loads `aerospike.env` when present; otherwise `conftest.py` loads `aerospike.env.example` for unset variables only (so CI env vars still win).
+
+## Running Tests
+
+```bash
+make test          # all tests
+make test-unit     # unit tests only
+make test-int      # integration tests only (requires running Aerospike server)
+```
+
+### macOS File Descriptor Limit
+
+On macOS, you may encounter `OSError: [Errno 24] Too many open files` when running the full test suite. The default limit (256) is not enough for the concurrent async connections created during testing.
+
+```bash
+ulimit -n 4096
+```
+
+To make this permanent, add it to your shell profile (`~/.zshrc` or `~/.bash_profile`).
+
+## Documentation
+
+API docs are built with [Sphinx](https://www.sphinx-doc.org/) (Furo theme, MyST-Parser for Markdown).
+
+```bash
+pip install -e ".[docs]"   # one-time: install Sphinx toolchain
+
+make docs                  # build static HTML to docs/_build/html/
+make docs-serve            # live-reloading local preview
+```
+
+Docstrings use Google style with Sphinx cross-references (`:meth:`, `:class:`, etc.).
+
+## Development
+
+```bash
+# Regenerate the ANTLR AEL parser (only needed if Condition.g4 changes)
+make generate-ael
+
+# Lint
+ruff check .
+```
+
+## Usage
+
+```python
+import asyncio
+from aerospike_sdk import Behavior, DataSet, Client
+
+async def main():
+    async with Client("localhost:3100") as client:
+        session = client.create_session(Behavior.DEFAULT)
+        users = DataSet.of("test", "users")
+
+        # High-level key-value operations
+        await session.upsert(key=users.id(1)).put({"name": "Alice", "age": 28, "country": "UK"})
+        await session.upsert(key=users.id(2)).put({"name": "Bob", "age": 35, "country": "US"})
+
+        # Query with string AEL -- stream results one at a time (memory-efficient)
+        results = await (
+            session.query(users)
+            .where("$.age > %s and $.country == '%s'", 25, "US")
+            .execute()
+        )
+        async for rec in results:
+            print(rec.bins)
+
+        # execute() returns a lazy async stream
+        all_users = await session.query(users).execute()
+        # collect() drains the stream into a list
+        user_list = await all_users.collect()
+
+asyncio.run(main())
+```
+
+## Versioning
+
+PSDK follows [SemVer](https://semver.org/) for releases. Pre-releases use the
+`MAJOR.MINOR.PATCH-{alpha,beta,rc}.N` form (e.g. `0.1.0-alpha.1`). PyPI
+normalizes these on upload to the equivalent PEP 440 spelling (`0.1.0a1`).
+
+### Single source of truth
+
+The top-level `VERSION` file is the only place where the version lives:
+
+```
+0.9.0-alpha.1
+```
+
+`pyproject.toml` reads it dynamically:
+
+```toml
+[project]
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = {file = "VERSION"}
+```
+
+So the wheel and the working tree are guaranteed to match.
+
+### Bumping the version
+
+Bumps are manual and happen in PRs against `dev`. Promotion workflows
+(`dev → stage → main`) do not mutate the version.
+
+```bash
+# 1. Edit VERSION:
+#    e.g. 0.1.0-alpha.1  →  0.1.0-alpha.2
+echo '0.1.0-alpha.2' > VERSION
+
+# 2. Confirm:
+bin/get-version    # prints 0.1.0-alpha.2
+
+# 3. Open a PR against dev with just this change.
+```
+
+### Bumping the PAC pin
+
+PSDK depends on a published release of the
+[Aerospike Python Async Client](https://github.com/aerospike/aerospike-client-python-async)
+on PyPI as `aerospike-async`. The pin lives in `pyproject.toml` under
+`[project] dependencies`:
+
+```toml
+"aerospike-async==0.4.0a1",
+```
+
+To bump: change the version to the new release on PyPI, then reinstall:
+
+```bash
+pip install --upgrade "aerospike-async==0.4.0aN"
+```
+
+Open the PR against `dev`. PSDK's own `VERSION` does not need to change for
+a PAC pin bump unless the underlying API contract has shifted enough to
+warrant it.
+
+### Reading the version programmatically
+
+Anywhere a build script, CI step, or release tool needs the version:
+
+```bash
+bin/get-version    # → 0.9.0-alpha.1
+```
+
+The script reads `VERSION` and trims trailing whitespace. No Python or
+setuptools runtime dependency — usable from any shell, container, or CI
+environment.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.

aerospike_sdk-0.9.0a1/README.md

@@ -0,0 +1,207 @@
+# Aerospike Python SDK
+
+A high-level API on the Aerospike Python Async Client, providing an intuitive and chainable interface for database operations.
+
+> **Status:** Public preview (alpha). Not yet production-ready; feedback welcome via GitHub Issues.
+
+## Prerequisites
+
+- **Python** 3.10 - 3.14 (recommended: [pyenv](https://github.com/pyenv/pyenv) with a dedicated environment for this repo)
+- **Aerospike server** -- required for integration tests
+- **Rust toolchain** (rustc + cargo) -- only needed if building the Aerospike Python Async Client from source
+- **Java 11+** -- required for the one-time AEL parser build (`make generate-ael`)
+
+## Install the Aerospike Python Async Client
+
+This SDK depends on the [Aerospike Python Async Client](https://github.com/aerospike/aerospike-client-python-async),
+published on PyPI as [`aerospike-async`](https://pypi.org/project/aerospike-async/).
+The version is pinned in `pyproject.toml` under `[project] dependencies`. A normal
+`pip install -e ".[dev]"` resolves it from PyPI automatically -- no Rust toolchain
+or git checkout required for ordinary development.
+
+### Local PAC checkout (development against an unreleased PAC tree)
+
+To test against a sibling PAC working tree (e.g. for a feature not yet on PyPI),
+install it editable first and pass `--no-deps` to this SDK so pip doesn't try
+to re-resolve PAC from PyPI:
+
+```bash
+pip install -e /path/to/aerospike-client-python-async
+pip install -e ".[dev]" --no-deps
+```
+
+Or use `requirements-local.txt` (gitignored path example).
+
+## Install this package
+
+Use the interpreter from your pyenv environment (see `.cursor/rules/guiding-principles.mdc` for the usual env name), then:
+
+```bash
+make generate-ael          # one-time: build the ANTLR AEL parser (requires Java 11+)
+pip install -e ".[dev]"
+```
+
+`make generate-ael` only needs to be re-run if `aerospike_sdk/ael/antlr4/Condition.g4` changes.
+
+## Configuration
+
+Copy `aerospike.env.example` to `aerospike.env` in the repo root and adjust hosts or ports. `aerospike.env` is not committed.
+
+```bash
+cp aerospike.env.example aerospike.env
+source aerospike.env
+```
+
+Pytest loads `aerospike.env` when present; otherwise `conftest.py` loads `aerospike.env.example` for unset variables only (so CI env vars still win).
+
+## Running Tests
+
+```bash
+make test          # all tests
+make test-unit     # unit tests only
+make test-int      # integration tests only (requires running Aerospike server)
+```
+
+### macOS File Descriptor Limit
+
+On macOS, you may encounter `OSError: [Errno 24] Too many open files` when running the full test suite. The default limit (256) is not enough for the concurrent async connections created during testing.
+
+```bash
+ulimit -n 4096
+```
+
+To make this permanent, add it to your shell profile (`~/.zshrc` or `~/.bash_profile`).
+
+## Documentation
+
+API docs are built with [Sphinx](https://www.sphinx-doc.org/) (Furo theme, MyST-Parser for Markdown).
+
+```bash
+pip install -e ".[docs]"   # one-time: install Sphinx toolchain
+
+make docs                  # build static HTML to docs/_build/html/
+make docs-serve            # live-reloading local preview
+```
+
+Docstrings use Google style with Sphinx cross-references (`:meth:`, `:class:`, etc.).
+
+## Development
+
+```bash
+# Regenerate the ANTLR AEL parser (only needed if Condition.g4 changes)
+make generate-ael
+
+# Lint
+ruff check .
+```
+
+## Usage
+
+```python
+import asyncio
+from aerospike_sdk import Behavior, DataSet, Client
+
+async def main():
+    async with Client("localhost:3100") as client:
+        session = client.create_session(Behavior.DEFAULT)
+        users = DataSet.of("test", "users")
+
+        # High-level key-value operations
+        await session.upsert(key=users.id(1)).put({"name": "Alice", "age": 28, "country": "UK"})
+        await session.upsert(key=users.id(2)).put({"name": "Bob", "age": 35, "country": "US"})
+
+        # Query with string AEL -- stream results one at a time (memory-efficient)
+        results = await (
+            session.query(users)
+            .where("$.age > %s and $.country == '%s'", 25, "US")
+            .execute()
+        )
+        async for rec in results:
+            print(rec.bins)
+
+        # execute() returns a lazy async stream
+        all_users = await session.query(users).execute()
+        # collect() drains the stream into a list
+        user_list = await all_users.collect()
+
+asyncio.run(main())
+```
+
+## Versioning
+
+PSDK follows [SemVer](https://semver.org/) for releases. Pre-releases use the
+`MAJOR.MINOR.PATCH-{alpha,beta,rc}.N` form (e.g. `0.1.0-alpha.1`). PyPI
+normalizes these on upload to the equivalent PEP 440 spelling (`0.1.0a1`).
+
+### Single source of truth
+
+The top-level `VERSION` file is the only place where the version lives:
+
+```
+0.9.0-alpha.1
+```
+
+`pyproject.toml` reads it dynamically:
+
+```toml
+[project]
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = {file = "VERSION"}
+```
+
+So the wheel and the working tree are guaranteed to match.
+
+### Bumping the version
+
+Bumps are manual and happen in PRs against `dev`. Promotion workflows
+(`dev → stage → main`) do not mutate the version.
+
+```bash
+# 1. Edit VERSION:
+#    e.g. 0.1.0-alpha.1  →  0.1.0-alpha.2
+echo '0.1.0-alpha.2' > VERSION
+
+# 2. Confirm:
+bin/get-version    # prints 0.1.0-alpha.2
+
+# 3. Open a PR against dev with just this change.
+```
+
+### Bumping the PAC pin
+
+PSDK depends on a published release of the
+[Aerospike Python Async Client](https://github.com/aerospike/aerospike-client-python-async)
+on PyPI as `aerospike-async`. The pin lives in `pyproject.toml` under
+`[project] dependencies`:
+
+```toml
+"aerospike-async==0.4.0a1",
+```
+
+To bump: change the version to the new release on PyPI, then reinstall:
+
+```bash
+pip install --upgrade "aerospike-async==0.4.0aN"
+```
+
+Open the PR against `dev`. PSDK's own `VERSION` does not need to change for
+a PAC pin bump unless the underlying API contract has shifted enough to
+warrant it.
+
+### Reading the version programmatically
+
+Anywhere a build script, CI step, or release tool needs the version:
+
+```bash
+bin/get-version    # → 0.9.0-alpha.1
+```
+
+The script reads `VERSION` and trims trailing whitespace. No Python or
+setuptools runtime dependency — usable from any shell, container, or CI
+environment.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.

aerospike_sdk-0.9.0a1/VERSION

@@ -0,0 +1 @@
+0.9.0-alpha.1