getlurk 0.2.1__tar.gz

getlurk-0.2.1/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Whatever lands here lands through the release job; these owners review anything else.
+*  @j0xhen

getlurk-0.2.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,31 @@
+name: Bug report
+description: Something does not work as the documentation says.
+body:
+  - type: markdown
+    attributes:
+      value: "**Never paste a Lurk key (`lurk_sk_…`), a webhook secret or a user token.** Error responses have a `request_id`: that is all we need to find it."
+  - type: input
+    id: version
+    attributes:
+      label: SDK version
+      placeholder: "1.4.0"
+    validations:
+      required: true
+  - type: input
+    id: runtime
+    attributes:
+      label: Runtime
+      placeholder: "Node 24, Python 3.12, Cloudflare Workers, ..."
+    validations:
+      required: true
+  - type: textarea
+    id: happened
+    attributes:
+      label: What you did and what happened
+      description: The smallest code that shows it, and the error (with its `request_id`).
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What you expected

getlurk-0.2.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Report a security problem
+    url: https://github.com/security/advisories/new
+    about: Use private vulnerability reporting, or write to security@getlurk.com. Never a public issue.
+  - name: Documentation
+    url: https://docs.getlurk.com
+    about: How Lurk works, with examples.

getlurk-0.2.1/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+Thanks for the change. **This repository is generated and cannot merge pull requests**: a maintainer will apply your change upstream (with you
+credited) and close this pull request with a link to the release. Please make sure your commits are signed off (`git commit -s`), and do not
+include any key or secret.

getlurk-0.2.1/.github/workflows/publish.yml

@@ -0,0 +1,85 @@
+# Publishes this package to PyPI. Written into this repository by Lurk's release job; do not edit it here (the next release overwrites it).
+#
+# - It runs only on a version tag, and only the release job can create one (a tag ruleset). A person approves the `publish` environment.
+# - There is no PyPI token anywhere: PyPI trusted publishing (OpenID Connect) gives the publish step a credential for this run only, and
+#   the package is published with attestations that say where it was built.
+# - The package is built and tested once, in a job with no way to publish; the `publish` job uploads exactly those files.
+name: Publish
+
+on:
+  push:
+    tags: ["v[0-9]+.[0-9]+.[0-9]+*"]
+  # A tag made through the API does not always start the push trigger above (the first release's did not). Run this workflow by hand
+  # from the mirror's Actions tab, choosing the version tag as the ref: the build refuses any ref that is not the package's own tag.
+  workflow_dispatch:
+
+permissions: {}
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
+        with:
+          python-version: "3.12"
+      - name: The tag is the package's version
+        run: |
+          VERSION="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          if [ "v${VERSION}" != "${GITHUB_REF_NAME}" ]; then
+            echo "The tag ${GITHUB_REF_NAME} is not the package version ${VERSION}." >&2
+            exit 1
+          fi
+      - name: The files are the ones the release job exported
+        run: |
+          python - <<'PY'
+          import hashlib, json, os, pathlib, sys
+          record = json.loads(pathlib.Path(".lurk-export.json").read_text())
+          bad = [f["path"] for f in record["files"] if hashlib.sha256(pathlib.Path(f["path"]).read_bytes()).hexdigest() != f["sha256"]]
+          listed = {f["path"] for f in record["files"]} | {".lurk-export.json"}
+          extra = [str(p) for p in pathlib.Path(".").rglob("*") if p.is_file() and ".git" not in p.parts and str(p) not in listed]
+          if bad or extra:
+              print("Changed since the export:", bad, "Not in the export:", extra, file=sys.stderr)
+              sys.exit(1)
+          if record["version"] != os.environ["GITHUB_REF_NAME"][1:]:
+              print("The export is for another version.", file=sys.stderr)
+              sys.exit(1)
+          PY
+      - run: python -m unittest discover -s tests -t .
+        env:
+          PYTHONPATH: src
+          PYTHONDONTWRITEBYTECODE: "1"
+      - run: python -m pip install --disable-pip-version-check build==1.6.1
+      - run: python -m build
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+          retention-days: 7
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment: publish
+    permissions:
+      contents: read
+      id-token: write # PyPI trusted publishing and attestations
+    steps:
+      - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          packages-dir: dist/

getlurk-0.2.1/.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+__pycache__/
+*.pyc
+.env
+.env.*
+*.log
+*.tgz

getlurk-0.2.1/.lurk-export.json

@@ -0,0 +1,127 @@
+{
+  "sdk": "python",
+  "version": "0.2.1",
+  "commit": "7123eed7548955503c2afe1e8ebd97b9da6fb263",
+  "files": [
+    {
+      "path": ".github/CODEOWNERS",
+      "sha256": "144109cee8f95a3badea6fac91e28e6d3a9d94643c3b89375d44167b5491d8d4"
+    },
+    {
+      "path": ".github/ISSUE_TEMPLATE/bug_report.yml",
+      "sha256": "7b75730158ae863390fb349df04a5f93b4ac1d642bee811135e4383c8f37fb67"
+    },
+    {
+      "path": ".github/ISSUE_TEMPLATE/config.yml",
+      "sha256": "160b810645105cdbd99855206e070b34a4657b2bf60828a66fd1137a94e9f984"
+    },
+    {
+      "path": ".github/pull_request_template.md",
+      "sha256": "17bb659bd19f944027823f9bd217704bbad32a54849d0e666662f77671e8d2b5"
+    },
+    {
+      "path": ".github/workflows/publish.yml",
+      "sha256": "1a06b226f5e82715eee2e79f7a567e2fe9ab6c0071d21699fd0fe6a3bd62907c"
+    },
+    {
+      "path": ".gitignore",
+      "sha256": "f1095da4fce29d500a89fc55a8c849d97b4bcf9e147b40a90ae9a9aa1ac54b4d"
+    },
+    {
+      "path": "CONTRIBUTING.md",
+      "sha256": "2fbd2618f78fc4d08f5b5a9af5c08531c0043d8ed437598dad629029f42958f8"
+    },
+    {
+      "path": "LICENSE",
+      "sha256": "cfc7749b96f63bd31c3c42b5c471bf756814053e847c10f3eb003417bc523d30"
+    },
+    {
+      "path": "NOTICE",
+      "sha256": "7f9872aa68373dce3b08f14d20bc44949db215a7615c1c63f150b3db197c1731"
+    },
+    {
+      "path": "README.md",
+      "sha256": "7cd19a7bda0d00c3378c73adf9f33cc0e05fc2b5c6843229af6b235231cf9f74"
+    },
+    {
+      "path": "SECURITY.md",
+      "sha256": "df1799b7e38761e44463c711a4835ec1691166bd78edce9dac182a1f6ff0b4f3"
+    },
+    {
+      "path": "examples/send_event.py",
+      "sha256": "be5749f9e53a3c44aa7a536a57083f78c5d9d08864cbdd8b5ec021a969f3a081"
+    },
+    {
+      "path": "examples/verify_webhook.py",
+      "sha256": "2c84be6eb1a9c60d91959daca9eadf957cd2fd2582953677cbb206cfe5f9f7f8"
+    },
+    {
+      "path": "pyproject.toml",
+      "sha256": "1389f77fb8aeb8148368736fae4ab6e0fc458ff9b8d05c89e99f9c51fd21cb09"
+    },
+    {
+      "path": "src/getlurk/__init__.py",
+      "sha256": "bd8c18000bde09f399b5f6738b45645484127ead7e1fdfa9523d40f9e19d7426"
+    },
+    {
+      "path": "src/getlurk/_generated/__init__.py",
+      "sha256": "e0ce3e07aeb02bbd46b410f8db596e959fcf106e4e49a0bb139aaafa88cbbf76"
+    },
+    {
+      "path": "src/getlurk/_generated/operations.py",
+      "sha256": "fab6aeab7465f03f1610f9c63adeddd8126c16db1ccead712827c16d45850c57"
+    },
+    {
+      "path": "src/getlurk/_generated/resources.py",
+      "sha256": "2d547bb8ec60d43bc5e618892edceb1363db9d1999b655b526100eb39ed2f9b2"
+    },
+    {
+      "path": "src/getlurk/_generated/schema.py",
+      "sha256": "111ec45d8f4b7db999a5a01ed7cdc7af56265db59bc09023e2c46312bd05b45e"
+    },
+    {
+      "path": "src/getlurk/_generated/types.py",
+      "sha256": "d3f75cfcc2e10e1ef1205cfb9051e8abb4a7c45bb89cb07d89f7ee201aa8a877"
+    },
+    {
+      "path": "src/getlurk/aio.py",
+      "sha256": "a693a8e685dffaa98f334959dd49f97c79afc729b311b321a16533ad1fb76164"
+    },
+    {
+      "path": "src/getlurk/client.py",
+      "sha256": "6148c22eef8effac727df20567cf3cf71943beca7460e4de147ed870c181cec5"
+    },
+    {
+      "path": "src/getlurk/errors.py",
+      "sha256": "5c2592732e28afe6220480b21049f442fa7b1729db6e038715b7d8adbe60c792"
+    },
+    {
+      "path": "src/getlurk/options.py",
+      "sha256": "b11b8006e5ced204108437183c0c65355ee20f27e4a494638c100f02ce469804"
+    },
+    {
+      "path": "src/getlurk/py.typed",
+      "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+    },
+    {
+      "path": "src/getlurk/webhooks.py",
+      "sha256": "841614f3ee6568bb43499a4c6d6833187680cdfd2ee95d291d0e7560144cadb5"
+    },
+    {
+      "path": "tests/__init__.py",
+      "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+    },
+    {
+      "path": "tests/test_aio.py",
+      "sha256": "065310d29a2c3987f925000866b7553ceb6578394ad0fca60d7f4250fc843501"
+    },
+    {
+      "path": "tests/test_client.py",
+      "sha256": "ac3e55d6fecbdd673f85ece4cb2837818bb5629033da7acc0f69939725560cd9"
+    },
+    {
+      "path": "tests/test_webhooks.py",
+      "sha256": "a305412374b5c24b2406652fab4e51d58d3017f5c9da57f79e198e490d98384e"
+    }
+  ]
+}

getlurk-0.2.1/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+This repository is **generated** from Lurk's private monorepo and is overwritten on each release, so a pull request cannot be merged here.
+
+- **Found a bug, or something confusing?** Open an issue. Say the SDK version, your runtime, what you did and the `request_id` from the error. Never include a key.
+- **Have a fix?** You are welcome to open a pull request as a way of showing us the change. A maintainer applies it upstream, with you credited as
+  co-author, and it arrives in the next release; we close the pull request with a link to that release.
+- **Sign your commits off** (`git commit -s`): by doing so you certify the [Developer Certificate of Origin 1.1](https://developercertificate.org/).
+  This SDK is licensed under Apache-2.0 and we do not ask for a separate agreement.
+- **Security problems** go to security@getlurk.com, not here (see SECURITY.md).

getlurk-0.2.1/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 [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.

getlurk-0.2.1/NOTICE

@@ -0,0 +1,6 @@
+Lurk SDK for Python (getlurk)
+Copyright 2026 Drip Rewards Inc.
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+"Lurk", the Lurk logo and the lurk mark are trademarks of Drip Rewards Inc. The Apache License does not grant permission to use them.

getlurk-0.2.1/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.5
+Name: getlurk
+Version: 0.2.1
+Summary: The Lurk API for Python
+Project-URL: Homepage, https://github.com/getlurk/lurk-sdk-py
+Project-URL: Source, https://github.com/getlurk/lurk-sdk-py
+Project-URL: Issues, https://github.com/getlurk/lurk-sdk-py/issues
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# lurk (Python SDK)
+
+The official Lurk API client for Python 3.11 and newer, with no dependencies.
+
+```bash
+pip install getlurk
+```
+
+```python
+from getlurk import Lurk
+
+lurk = Lurk()  # reads the key from LURK_KEY
+receipt = lurk.events.send({"event": "checkin.scanned", "user": "maya@example.com"})
+```
+
+Pass the input as a dict (typed by `getlurk.types.EventsSendInput`) or as keywords: `lurk.events.send(event="checkin.scanned", user="maya@example.com")`.
+
+**Keep the key on your server.** A secret key (`lurk_sk_…`) must never reach a browser or an app. Start in a Staging project so nothing reaches
+real people until you mean it. See [docs.getlurk.com](https://docs.getlurk.com) for the guides.
+
+## What it does for you
+
+- **Idempotency keys.** Every write that can carry one gets one, made once per call and sent again on every retry. Pass your own with `options=RequestOptions(idempotency_key=...)`.
+- **Retries, only where they are safe.** Reads and writes with a key are retried on a connection error, `408` and `5xx`, twice by default, with jittered backoff. A rate-limit answer (`429`) is
+  retried after the `Retry-After` it gives (up to 60 seconds; longer raises so you can decide). A write with no key (`api_keys.create`, `webhook_endpoints.create`) is never repeated.
+- **Typed errors.** `LurkError` has `status`, `code`, `param`, `request_id`, `doc_url` and `retry_after_seconds`; `LurkConnectionError` means there was no answer.
+- **Pages.** `for rule in lurk.paginate("rules.list")` fetches the next page as you go.
+- **asyncio.** `AsyncLurk` takes the same arguments and has the same methods, awaited: `await lurk.events.send(...)` and `async for rule in lurk.paginate("rules.list")`. Calls run on a worker thread, so they never block your event loop, and idempotency keys, retries and typed errors are the sync client's.
+- **Webhook checks.** `construct_event(body, headers, secret)` verifies a delivery's signature and returns the event.
+- **Your own transport.** `Lurk(transport=...)` replaces the HTTP call (a proxy, another library, a test double).
+
+## Versions and changes
+
+The SDK follows [semantic versioning](https://semver.org). The API's changes and the SDK's are in the [changelog](https://docs.getlurk.com/changelog).
+Only the latest major version receives fixes.
+
+## Help
+
+Open an [issue](https://github.com/getlurk/lurk-sdk-py/issues) (never include a key; the `request_id` of an error is enough), or read
+[CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md). Licensed under the Apache License 2.0 (see [LICENSE](LICENSE) and [NOTICE](NOTICE)).

getlurk-0.2.1/README.md

@@ -0,0 +1,40 @@
+# lurk (Python SDK)
+
+The official Lurk API client for Python 3.11 and newer, with no dependencies.
+
+```bash
+pip install getlurk
+```
+
+```python
+from getlurk import Lurk
+
+lurk = Lurk()  # reads the key from LURK_KEY
+receipt = lurk.events.send({"event": "checkin.scanned", "user": "maya@example.com"})
+```
+
+Pass the input as a dict (typed by `getlurk.types.EventsSendInput`) or as keywords: `lurk.events.send(event="checkin.scanned", user="maya@example.com")`.
+
+**Keep the key on your server.** A secret key (`lurk_sk_…`) must never reach a browser or an app. Start in a Staging project so nothing reaches
+real people until you mean it. See [docs.getlurk.com](https://docs.getlurk.com) for the guides.
+
+## What it does for you
+
+- **Idempotency keys.** Every write that can carry one gets one, made once per call and sent again on every retry. Pass your own with `options=RequestOptions(idempotency_key=...)`.
+- **Retries, only where they are safe.** Reads and writes with a key are retried on a connection error, `408` and `5xx`, twice by default, with jittered backoff. A rate-limit answer (`429`) is
+  retried after the `Retry-After` it gives (up to 60 seconds; longer raises so you can decide). A write with no key (`api_keys.create`, `webhook_endpoints.create`) is never repeated.
+- **Typed errors.** `LurkError` has `status`, `code`, `param`, `request_id`, `doc_url` and `retry_after_seconds`; `LurkConnectionError` means there was no answer.
+- **Pages.** `for rule in lurk.paginate("rules.list")` fetches the next page as you go.
+- **asyncio.** `AsyncLurk` takes the same arguments and has the same methods, awaited: `await lurk.events.send(...)` and `async for rule in lurk.paginate("rules.list")`. Calls run on a worker thread, so they never block your event loop, and idempotency keys, retries and typed errors are the sync client's.
+- **Webhook checks.** `construct_event(body, headers, secret)` verifies a delivery's signature and returns the event.
+- **Your own transport.** `Lurk(transport=...)` replaces the HTTP call (a proxy, another library, a test double).
+
+## Versions and changes
+
+The SDK follows [semantic versioning](https://semver.org). The API's changes and the SDK's are in the [changelog](https://docs.getlurk.com/changelog).
+Only the latest major version receives fixes.
+
+## Help
+
+Open an [issue](https://github.com/getlurk/lurk-sdk-py/issues) (never include a key; the `request_id` of an error is enough), or read
+[CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md). Licensed under the Apache License 2.0 (see [LICENSE](LICENSE) and [NOTICE](NOTICE)).

getlurk-0.2.1/SECURITY.md

@@ -0,0 +1,9 @@
+# Security
+
+Please report a vulnerability to **security@getlurk.com**, or privately through this repository's **Security** tab ("Report a vulnerability").
+Do not open a public issue for it. We acknowledge within 2 business days.
+
+This SDK is **generated** from Lurk's API description and released as a snapshot; a fix ships as a patch release of the latest version.
+Only the latest major version is supported.
+
+Never put a Lurk secret key (`lurk_sk_…`) or a webhook secret in an issue, a log or a screenshot. If you did, revoke it in the dashboard first.

getlurk-0.2.1/examples/send_event.py

@@ -0,0 +1,14 @@
+from getlurk import Lurk
+
+lurk = Lurk()  # reads the key from LURK_KEY
+
+receipt = lurk.events.send(
+    {
+        "event": "checkin.scanned",
+        "user": "maya@example.com",
+        "properties": {"venue": "mission-st"},
+        "idempotency_key": "chk-mission-st-maya-0812",
+    }
+)
+
+print(receipt["receipts"])

getlurk-0.2.1/examples/verify_webhook.py

@@ -0,0 +1,18 @@
+import os
+
+from flask import Flask, abort, request  # any framework: you only need the raw body and the headers
+
+from getlurk import WebhookVerificationError, construct_event
+
+app = Flask(__name__)
+
+
+@app.post("/webhooks/lurk")
+def lurk_webhook():
+    try:
+        event = construct_event(request.get_data(), request.headers, os.environ["LURK_WEBHOOK_SECRET"])
+    except WebhookVerificationError:
+        abort(400)
+    if event["type"] == "activity.created":
+        print(event["data"]["receipts"])
+    return "", 204

getlurk-0.2.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "getlurk"
+version = "0.2.1"
+description = "The Lurk API for Python"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = []
+license = { text = "Apache-2.0" }
+license-files = ["LICENSE", "NOTICE"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/getlurk"]
+
+[project.urls]
+Homepage = "https://github.com/getlurk/lurk-sdk-py"
+Source = "https://github.com/getlurk/lurk-sdk-py"
+Issues = "https://github.com/getlurk/lurk-sdk-py/issues"