Updates to convex-py

GitOrigin-RevId: 41bcd7ec888eed10324a22d61eb0e3d91d5b65cf

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 100
+extend_ignore = D105
+per_file_ignores =
+    tests/*.py:D100,D103,D104
+    *example*.py:D100,D103
+exclude = .venv

.gitignore

@@ -0,0 +1,7 @@
+dist
+# dev-specific path to virtualenv, useful for the pyright language server
+# unless you are using VSCode which handles it for you.
+pyrightconfig.json
+
+# binary output
+python/_convex/_convex.*.so

.prettierignore

@@ -0,0 +1,2 @@
+.mypy_cache/
+.pytest_cache/

.prettierrc

@@ -0,0 +1,2 @@
+proseWrap: "always"
+arrowParens: "avoid"

CHANGELOG.md

@@ -0,0 +1,57 @@
+# Upcoming
+
+# 0.6.0
+
+This is a rewrite adding subscribing to live query updates. The Python client
+now wraps the [Convex Rust client](https://docs.rs/convex) using the
+PyO3[https://pyo3.rs/].
+
+The API is a superset but if you encounter unexpected incompatibilities consider
+the old client, moved to `convex.http_client`.
+
+# 0.5.1
+
+- Expose ConvexInt64 from the top level `convex` module.
+
+# 0.5.0
+
+- Remove ConvexMap and ConvexSet: these types are no longer allowed as arguments
+  or returned by Convex functions.
+
+  See the [NPM version 0.19.0](https://news.convex.dev/announcing-convex-0-19-0)
+  release notes for more.
+
+  If you need to communicate with a backend with functions that accept or return
+  these types, _stay on version 0.4.0_.
+
+- `ConvexClient.set_debug()` no longer applies to production deployments: logs
+  from production deployments are no longer sent to clients, only appearing on
+  the Convex dashboard.
+
+- Add Support for `ConvexError`.
+
+# 0.4.0
+
+- Remove the `Id` class since document IDs are strings for Convex functions
+  starting from
+  [NPM version 0.17](https://news.convex.dev/announcing-convex-0-17-0/)
+- Add warnings when calling functions on deprecated versions of Convex
+
+# 0.3.0
+
+This release corresponds with Convex npm release 0.13.0.
+
+- `mutation()`, `action()`, and `query()` now take two arguments: the function
+  name and an (optional) arguments dictionary. See
+  https://news.convex.dev/announcing-convex-0-13-0/ for more about this change.
+
+  If you need to communicate with a Convex backend with functions with
+  positional arguments instead of a single arguments object, _stay on version
+  0.2.0_.
+
+# 0.2.0
+
+- Both python `int` and `float` will coerce to a `number` type in Convex's JS
+  environment. If you need a JS `bigint`, use a python `ConvexInt64`. Convex
+  functions are written in JavaScript where `number` is used pervasively, so
+  this change generally simplifies using Convex functions from python.

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing
+
+Contributions are welcome!
+
+Please share any general questions, feature requests, or product feedback in our
+[Convex Discord Community](https://convex.dev/community). We're particularly
+excited to see what you build on Convex!
+
+Please ensure that python code is formatted with
+[black](https://pypi.org/project/black/) and markdown files are formatted with
+[prettier](https://prettier.io/).
+
+Run tests with
+
+```
+poetry install
+poetry run pytest
+```
+
+Convex is a fast moving project developed by a dedicated team. We're excited to
+contribute to the community by releasing this code, but we want to manage
+expectations as well.
+
+- We are a small company with a lot of product surface area.
+- We value a cohesive developer experience for folks building applications
+  across all of our languages and platforms.
+- We value transparency in how we operate.
+
+We're excited for community PRs. Be aware we may not get to it for a while.
+Smaller PRs that only affect documentation/comments are easier to review and
+integrate. For any larger or more fundamental changes, get in touch with us on
+Discord before you put in too much work to see if it's consistent with our short
+term plan. We think carefully about how our APIs contribute to a cohesive
+product, so chatting up front goes a long way.
+
+# Development notes
+
+You'll need a Rust toolchain installed (e.g. through https://rustup.rs/) to
+build this library when developing locally.
+
+```sh
+# install dependencies
+poetry install --no-root
+
+# build _convex
+# This is requred to run tests and to use from other local installations (like smoke tests)
+poetry run maturin dev
+
+# run a test script
+poetry run python simple_example.py
+
+# interactive shell
+poetry run python
+>>> from convex import ConvexClient
+>>> client = ConvexClint("https://flippant-cardinal-923.convex.cloud")
+>>> print(client.query("users:list"))
+
+# The wrapped Rust client can also be run in an interactive shell
+>>> from _convex import PyConvexClient
+>>> client = PyConvexClient("https://flippant-cardinal-923.convex.cloud")
+>>> print(client.query("users:list"))
+
+```
+
+This package depends on the [convex](https://crates.io/crates/convex) package on
+crates.io. Updating behavior defined in that package requires publishing an
+update to that crate and updating the version required in this project.

Cargo.toml

@@ -1,27 +1,30 @@
 [package]
-name = "py_client"
+name = "_convex"
 version = "0.1.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]
-name = "py_client"
+name = "_convex"
 crate-type = ["cdylib"]
 
 [dependencies]
-convex = { path = "../convex" }
+convex = { version = "=0.6.0" }
 futures = { workspace = true }
 parking_lot = { workspace = true }
-pyo3 = { workspace = true }
+pyo3 = { workspace = true, features = ["abi3", "abi3-py39"] }
 pyo3-asyncio = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 tracing = { workspace = true }
 tracing-subscriber = { workspace = true, features = ["env-filter"] }
 
 [dev-dependencies]
-convex = { path = "../convex", features = ["testing"] }
+convex = { version = "=0.6.0", features = [ "testing" ] }
 tracing-subscriber = { workspace = true, features = ["env-filter"] }
 
+[build-dependencies]
+pyo3-build-config = { version = "0.20.2", features = ["resolve-config"] }
+
 [features]
 default = ["native-tls"]
 native-tls = ["convex/native-tls"]

LICENSE

@@ -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 2023 Convex, Inc.
+
+   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.