shrtnr 0.1.0__tar.gz

shrtnr-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/

shrtnr-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0
+
+First release of the Python SDK. Method-for-method parity with the TypeScript SDK.
+
+- Sync `Shrtnr` client built on `httpx.Client` and async `AsyncShrtnr` client built on `httpx.AsyncClient`.
+- Full link lifecycle: create, list, get, update, disable, enable, delete, list by owner.
+- Slug management: add, disable, enable, remove, lookup by slug.
+- Click analytics, QR code SVG, and service health check.
+- Bundles: create, list, get, update, delete, archive, unarchive, analytics, membership management, reverse lookup.
+- Bearer-token auth matching the TypeScript SDK, plus `X-Client: sdk` header.
+- Typed with frozen dataclasses and `Literal` types; `py.typed` marker ships in the wheel.
+- Works on Python 3.9 and later.

shrtnr-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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 the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "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 the 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 any 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
+
+   Copyright 2026 Oddbit (https://oddbit.id)
+
+   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.

shrtnr-0.1.0/PKG-INFO

@@ -0,0 +1,372 @@
+Metadata-Version: 2.4
+Name: shrtnr
+Version: 0.1.0
+Summary: SDK for the shrtnr URL shortener API
+Project-URL: Homepage, https://oddb.it/shrtnr-website-pypi
+Project-URL: Repository, https://github.com/oddbit/shrtnr
+Project-URL: Changelog, https://github.com/oddbit/shrtnr/blob/main/sdk/python/CHANGELOG.md
+Project-URL: Issues, https://github.com/oddbit/shrtnr/issues
+Author-email: Oddbit <hello@oddbit.id>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: click-analytics,cloudflare-d1,cloudflare-workers,custom-slug,link-management,link-shortener,python,sdk,short-url,shorten-url,shrtnr,url-shortener
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# shrtnr: URL Shortener SDK for Python
+
+Python client for creating short links, managing URLs, and reading click analytics from a [shrtnr](https://oddb.it/shrtnr-website-pypi) instance. Ships synchronous and asynchronous clients sharing the same method surface.
+
+## Install
+
+```bash
+pip install shrtnr
+```
+
+Python 3.9 or newer. `httpx` is the only runtime dependency.
+
+## Quick Start
+
+```python
+from shrtnr import Shrtnr, CreateLinkOptions
+
+with Shrtnr("https://your-shrtnr.example.com", api_key="sk_your_api_key") as client:
+    link = client.create_link(CreateLinkOptions(
+        url="https://example.com/long-page",
+        label="Campaign landing page",
+    ))
+    print(link)  # Link(id=1, slugs=[Slug(slug='a3x', ...)], ...)
+```
+
+Async usage is identical, with `await` and an `async with`:
+
+```python
+import asyncio
+from shrtnr import AsyncShrtnr, CreateLinkOptions
+
+async def main() -> None:
+    async with AsyncShrtnr("https://your-shrtnr.example.com", api_key="sk_your_api_key") as client:
+        link = await client.create_link(CreateLinkOptions(url="https://example.com"))
+        print(link)
+
+asyncio.run(main())
+```
+
+## What This SDK Covers
+
+This package wraps the public link-management API:
+
+- Shorten URLs (create short links)
+- Add, disable, enable, and remove custom slugs
+- List, read, update, disable, enable, and delete links
+- List links by owner identity
+- Read click analytics (referrer, country, device, browser)
+- Group links into bundles and read combined engagement stats
+- Check service health
+
+Administrative operations (API key management, settings, dashboard stats) are not part of this package. Those are accessible through the admin UI.
+
+## API Reference
+
+Every method below exists on both `Shrtnr` (sync) and `AsyncShrtnr` (async). Async examples are omitted for brevity but mirror the sync examples with `await`.
+
+### `create_link`
+
+Shorten a URL. Returns a `Link` with a random slug.
+
+```python
+import time
+
+link = client.create_link(CreateLinkOptions(
+    url="https://example.com",
+    label="My link to the example page",
+    expires_at=int(time.time()) + 86400,
+))
+```
+
+To add a custom slug, call `add_custom_slug` after creation:
+
+```python
+link = client.create_link(CreateLinkOptions(url="https://example.com"))
+slug = client.add_custom_slug(link.id, "my-campaign")
+```
+
+### `list_links`
+
+List all short links.
+
+```python
+links = client.list_links()
+```
+
+### `get_link`
+
+Get a single link by ID, including its slugs and click count.
+
+```python
+link = client.get_link(123)
+```
+
+### `get_link_by_slug`
+
+Get a single link by its short URL slug (including custom slugs).
+
+```python
+link = client.get_link_by_slug("my-custom-slug")
+```
+
+### `update_link`
+
+Update a link's URL, label, or expiry. Omit fields to leave them unchanged; pass `None` explicitly to clear them on the server.
+
+```python
+updated = client.update_link(123, UpdateLinkOptions(
+    label="Updated label",
+    expires_at=None,
+))
+```
+
+### `disable_link`
+
+Disable a link so it stops redirecting.
+
+```python
+disabled = client.disable_link(123)
+```
+
+### `enable_link`
+
+Re-enable a previously disabled link.
+
+```python
+link = client.enable_link(123)
+```
+
+### `delete_link`
+
+Permanently delete a link. Only succeeds if the link has zero clicks — disable it instead if it has traffic.
+
+```python
+client.delete_link(123)
+```
+
+### `list_links_by_owner`
+
+List all links created by a specific identity (typically an email address).
+
+```python
+links = client.list_links_by_owner("user@example.com")
+```
+
+### `add_custom_slug`
+
+Add a custom short URL slug to an existing link. Raises `ShrtnrError` with status 409 if the slug already exists, or 400 for invalid format.
+
+```python
+slug = client.add_custom_slug(123, "campaign")
+```
+
+### `disable_slug`
+
+Disable a custom slug without affecting the parent link or its other slugs.
+
+```python
+client.disable_slug(123, "campaign")
+```
+
+### `enable_slug`
+
+Re-enable a disabled custom slug.
+
+```python
+client.enable_slug(123, "campaign")
+```
+
+### `remove_slug`
+
+Permanently remove a custom slug. Only succeeds if the slug has zero clicks.
+
+```python
+client.remove_slug(123, "campaign")
+```
+
+### `get_link_qr`
+
+Fetch the QR code SVG for a link as a string. Optionally specify which slug to encode.
+
+```python
+svg = client.get_link_qr(123)
+svg_for_slug = client.get_link_qr(123, slug="my-campaign")
+```
+
+### `get_link_analytics`
+
+Read click analytics for a link: referrer, country, device type, and browser breakdown.
+
+```python
+analytics = client.get_link_analytics(123)
+```
+
+### `health`
+
+Check service health and version.
+
+```python
+health = client.health()
+```
+
+### `create_bundle`
+
+Create a bundle to group related links. Returns the new `Bundle`.
+
+```python
+bundle = client.create_bundle(CreateBundleOptions(
+    name="Spring campaign",
+    description="Email, social, and paid drops",
+    icon="sparkles",
+    accent="purple",
+))
+```
+
+### `list_bundles`
+
+List bundles with summary stats: lifetime click total, 30-day sparkline, and top links. Archived bundles are hidden by default.
+
+```python
+bundles = client.list_bundles()
+with_archived = client.list_bundles(archived=True)
+```
+
+### `get_bundle`
+
+Fetch a single bundle's metadata by ID.
+
+```python
+bundle = client.get_bundle(42)
+```
+
+### `update_bundle`
+
+Rename a bundle or change its description, icon, or accent.
+
+```python
+updated = client.update_bundle(42, UpdateBundleOptions(
+    name="Spring 2026 campaign",
+    accent="green",
+))
+```
+
+### `delete_bundle`
+
+Permanently delete a bundle. Member links are preserved, only the grouping is discarded.
+
+```python
+client.delete_bundle(42)
+```
+
+### `archive_bundle`
+
+Archive a bundle so it drops out of the default `list_bundles` response. Member links keep working.
+
+```python
+client.archive_bundle(42)
+```
+
+### `unarchive_bundle`
+
+Restore a previously archived bundle.
+
+```python
+client.unarchive_bundle(42)
+```
+
+### `get_bundle_analytics`
+
+Read combined analytics across every link in the bundle: timeline, per-link breakdown, countries, devices, browsers. Pass a `TimelineRange` to set the window (default `"30d"`).
+
+```python
+stats = client.get_bundle_analytics(42, range="7d")
+print(stats.total_clicks, stats.per_link)
+```
+
+### `list_bundle_links`
+
+List every link currently in a bundle.
+
+```python
+links = client.list_bundle_links(42)
+```
+
+### `add_link_to_bundle`
+
+Attach a link to a bundle. Idempotent: re-adding an existing member is a no-op.
+
+```python
+client.add_link_to_bundle(42, 123)
+```
+
+### `remove_link_from_bundle`
+
+Detach a link from a bundle. The link itself stays, only the membership is removed.
+
+```python
+client.remove_link_from_bundle(42, 123)
+```
+
+### `list_bundles_for_link`
+
+List every bundle a given link belongs to.
+
+```python
+bundles = client.list_bundles_for_link(123)
+```
+
+## Error Handling
+
+Non-2xx responses raise `ShrtnrError` with the status code, message, and raw response body.
+
+```python
+from shrtnr import ShrtnrError
+
+try:
+    client.get_link(99999)
+except ShrtnrError as error:
+    print(error.status)   # 404
+    print(str(error))     # "not found"
+    print(error.body)
+```
+
+Custom slug collisions and format errors from `add_custom_slug` raise `ShrtnrError` (status 409 or 400). Handle them per-call.
+
+## Differences from the TypeScript SDK
+
+The Python SDK mirrors the TypeScript SDK method-for-method, with a few idiomatic adaptations:
+
+- **Sync + async clients.** `Shrtnr` uses `httpx.Client`; `AsyncShrtnr` uses `httpx.AsyncClient`. Surface is identical.
+- **Naming.** `snake_case` throughout (`create_link`, `get_link_analytics`), matching PEP 8.
+- **Error class.** `ShrtnrError` subclasses `Exception`. Catch with `except ShrtnrError`.
+- **Timestamps.** Unix seconds as `int`, matching the wire format. No `datetime` conversion.
+- **Options.** `CreateLinkOptions` / `UpdateLinkOptions` / `CreateBundleOptions` / `UpdateBundleOptions` are dataclasses. `UpdateLinkOptions` treats omitted fields as "leave unchanged"; pass `None` to clear on the server.
+- **Return types.** Frozen dataclasses for every response model. Full type hints; `mypy --strict` clean.
+
+## License
+
+Apache-2.0. See the root [LICENSE](../../LICENSE) file.