useshards 0.1.0a1__tar.gz

useshards-0.1.0a1/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.
+

useshards-0.1.0a1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: useshards
+Version: 0.1.0a1
+Summary: A minimal Shard API client. This alpha supports server version requests.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://useshards.com
+Project-URL: Repository, https://github.com/presmihaylov/shard
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# useshards
+
+A minimal Python client for [Shard](https://github.com/presmihaylov/shard).
+
+This alpha supports only `GET /v0/version`. Sandbox creation, command execution,
+and file operations are not available in this release. Python 3.10 or later is required.
+The package has no runtime dependencies.
+
+```sh
+pip install --pre useshards
+```
+
+```python
+from useshards import Shard
+
+shard = Shard(url="https://shard.example.com", api_key="YOUR_API_KEY")
+print(shard.version())
+```
+
+```python
+import asyncio
+from useshards import AsyncShard
+
+async def main():
+    shard = AsyncShard()  # Uses SHARD_REMOTE and SHARD_API_KEY.
+    print(await shard.version())
+
+asyncio.run(main())
+```
+
+`url` defaults to `SHARD_REMOTE`. `api_key` defaults to `SHARD_API_KEY`.
+Use the server base URL without `/v0`. Base paths are supported.
+The current server requires a token with `daemon:read` or `*` for this endpoint.
+Use HTTPS for remote connections. HTTP supports local servers or a trusted network.
+Redirects are rejected. The socket timeout defaults to 30 seconds:
+
+```python
+print(shard.version(timeout=5))
+```
+
+`AsyncShard` uses a worker thread for HTTP requests in this minimal release.
+Cancellation stops the await, but the HTTP request can continue until its timeout.
+HTTP failures, malformed responses, and connection failures raise exceptions.
+The API is experimental. Future alpha releases can change it.
+
+Website: https://useshards.com
+
+License: Apache-2.0

useshards-0.1.0a1/README.md

@@ -0,0 +1,48 @@
+# useshards
+
+A minimal Python client for [Shard](https://github.com/presmihaylov/shard).
+
+This alpha supports only `GET /v0/version`. Sandbox creation, command execution,
+and file operations are not available in this release. Python 3.10 or later is required.
+The package has no runtime dependencies.
+
+```sh
+pip install --pre useshards
+```
+
+```python
+from useshards import Shard
+
+shard = Shard(url="https://shard.example.com", api_key="YOUR_API_KEY")
+print(shard.version())
+```
+
+```python
+import asyncio
+from useshards import AsyncShard
+
+async def main():
+    shard = AsyncShard()  # Uses SHARD_REMOTE and SHARD_API_KEY.
+    print(await shard.version())
+
+asyncio.run(main())
+```
+
+`url` defaults to `SHARD_REMOTE`. `api_key` defaults to `SHARD_API_KEY`.
+Use the server base URL without `/v0`. Base paths are supported.
+The current server requires a token with `daemon:read` or `*` for this endpoint.
+Use HTTPS for remote connections. HTTP supports local servers or a trusted network.
+Redirects are rejected. The socket timeout defaults to 30 seconds:
+
+```python
+print(shard.version(timeout=5))
+```
+
+`AsyncShard` uses a worker thread for HTTP requests in this minimal release.
+Cancellation stops the await, but the HTTP request can continue until its timeout.
+HTTP failures, malformed responses, and connection failures raise exceptions.
+The API is experimental. Future alpha releases can change it.
+
+Website: https://useshards.com
+
+License: Apache-2.0

useshards-0.1.0a1/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "useshards"
+version = "0.1.0a1"
+description = "A minimal Shard API client. This alpha supports server version requests."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+
+[project.urls]
+Homepage = "https://useshards.com"
+Repository = "https://github.com/presmihaylov/shard"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+useshards = ["py.typed"]

useshards-0.1.0a1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

useshards-0.1.0a1/src/useshards/__init__.py

@@ -0,0 +1,3 @@
+from .client import AsyncShard, Shard
+
+__all__ = ["Shard", "AsyncShard"]

useshards-0.1.0a1/src/useshards/client.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import asyncio
+import json
+import os
+from urllib.error import HTTPError
+from urllib.parse import urlsplit, urlunsplit
+from urllib.request import HTTPRedirectHandler, Request, build_opener
+
+
+class _NoRedirect(HTTPRedirectHandler):
+    def redirect_request(self, req, fp, code, msg, headers, newurl):
+        return None
+
+
+class Shard:
+    def __init__(self, *, url: str | None = None, api_key: str | None = None):
+        endpoint = os.environ.get("SHARD_REMOTE")
+        if url is not None:
+            endpoint = url
+        if not endpoint:
+            raise ValueError("Set url or SHARD_REMOTE to the Shard server URL")
+        parts = urlsplit(endpoint)
+        if parts.scheme not in {"http", "https"} or not parts.hostname:
+            raise ValueError("The Shard server URL must use HTTP or HTTPS")
+        if parts.username or parts.password or parts.query or parts.fragment:
+            raise ValueError("The Shard server URL must not contain credentials, a query, or a fragment")
+        self._url = urlunsplit((parts.scheme, parts.netloc, parts.path.rstrip("/") + "/v0/version", "", ""))
+        self._api_key = os.environ.get("SHARD_API_KEY")
+        if api_key is not None:
+            self._api_key = api_key
+
+    def version(self, *, timeout: float = 30) -> str:
+        headers = {"Accept": "application/json"}
+        if self._api_key:
+            headers["Authorization"] = f"Bearer {self._api_key}"
+        request = Request(self._url, headers=headers)
+        try:
+            with build_opener(_NoRedirect()).open(request, timeout=timeout) as response:
+                result = json.load(response)
+        except HTTPError as error:
+            error.close()
+            raise RuntimeError(f"Shard version request failed (HTTP {error.code})") from error
+        if not isinstance(result, dict) or not isinstance(result.get("version"), str):
+            raise ValueError("The Shard server returned an invalid version response")
+        return result["version"]
+
+
+class AsyncShard:
+    def __init__(self, *, url: str | None = None, api_key: str | None = None):
+        self._client = Shard(url=url, api_key=api_key)
+
+    async def version(self, *, timeout: float = 30) -> str:
+        return await asyncio.to_thread(self._client.version, timeout=timeout)

useshards-0.1.0a1/src/useshards.egg-info/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: useshards
+Version: 0.1.0a1
+Summary: A minimal Shard API client. This alpha supports server version requests.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://useshards.com
+Project-URL: Repository, https://github.com/presmihaylov/shard
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# useshards
+
+A minimal Python client for [Shard](https://github.com/presmihaylov/shard).
+
+This alpha supports only `GET /v0/version`. Sandbox creation, command execution,
+and file operations are not available in this release. Python 3.10 or later is required.
+The package has no runtime dependencies.
+
+```sh
+pip install --pre useshards
+```
+
+```python
+from useshards import Shard
+
+shard = Shard(url="https://shard.example.com", api_key="YOUR_API_KEY")
+print(shard.version())
+```
+
+```python
+import asyncio
+from useshards import AsyncShard
+
+async def main():
+    shard = AsyncShard()  # Uses SHARD_REMOTE and SHARD_API_KEY.
+    print(await shard.version())
+
+asyncio.run(main())
+```
+
+`url` defaults to `SHARD_REMOTE`. `api_key` defaults to `SHARD_API_KEY`.
+Use the server base URL without `/v0`. Base paths are supported.
+The current server requires a token with `daemon:read` or `*` for this endpoint.
+Use HTTPS for remote connections. HTTP supports local servers or a trusted network.
+Redirects are rejected. The socket timeout defaults to 30 seconds:
+
+```python
+print(shard.version(timeout=5))
+```
+
+`AsyncShard` uses a worker thread for HTTP requests in this minimal release.
+Cancellation stops the await, but the HTTP request can continue until its timeout.
+HTTP failures, malformed responses, and connection failures raise exceptions.
+The API is experimental. Future alpha releases can change it.
+
+Website: https://useshards.com
+
+License: Apache-2.0

useshards-0.1.0a1/src/useshards.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/useshards/__init__.py
+src/useshards/client.py
+src/useshards/py.typed
+src/useshards.egg-info/PKG-INFO
+src/useshards.egg-info/SOURCES.txt
+src/useshards.egg-info/dependency_links.txt
+src/useshards.egg-info/top_level.txt
+tests/test_version.py

useshards-0.1.0a1/src/useshards.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

useshards-0.1.0a1/src/useshards.egg-info/top_level.txt

@@ -0,0 +1 @@
+useshards

useshards-0.1.0a1/tests/test_version.py

@@ -0,0 +1,77 @@
+import asyncio
+import json
+import os
+import threading
+import unittest
+from contextlib import contextmanager
+from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
+from unittest.mock import patch
+
+from useshards import AsyncShard, Shard
+
+
+@contextmanager
+def server(status=200, payload=None, redirect=None):
+    requests = []
+
+    class Handler(BaseHTTPRequestHandler):
+        def do_GET(self):
+            requests.append((self.path, self.headers.get("Authorization")))
+            self.send_response(status)
+            if redirect:
+                self.send_header("Location", redirect)
+            self.end_headers()
+            self.wfile.write(json.dumps(payload).encode())
+
+        def log_message(self, format, *args):
+            pass
+
+    instance = ThreadingHTTPServer(("127.0.0.1", 0), Handler)
+    thread = threading.Thread(target=instance.serve_forever, daemon=True)
+    thread.start()
+    try:
+        yield f"http://127.0.0.1:{instance.server_port}", requests
+    finally:
+        instance.shutdown()
+        instance.server_close()
+        thread.join()
+
+
+class VersionTests(unittest.TestCase):
+    def test_path_and_auth(self):
+        with server(payload={"version": "test-version"}) as (url, requests):
+            self.assertEqual(Shard(url=url + "/gateway/", api_key="synthetic-key").version(), "test-version")
+            self.assertEqual(requests, [("/gateway/v0/version", "Bearer synthetic-key")])
+
+    def test_environment_defaults(self):
+        with server(payload={"version": "env-version"}) as (url, requests):
+            with patch.dict(os.environ, {"SHARD_REMOTE": url, "SHARD_API_KEY": "env-key"}):
+                self.assertEqual(Shard().version(), "env-version")
+            self.assertEqual(requests[0][1], "Bearer env-key")
+
+    def test_async(self):
+        with server(payload={"version": "async-version"}) as (url, requests):
+            self.assertEqual(asyncio.run(AsyncShard(url=url).version()), "async-version")
+
+    def test_http_error(self):
+        with server(status=401) as (url, requests):
+            with self.assertRaisesRegex(RuntimeError, "HTTP 401"):
+                Shard(url=url).version()
+
+    def test_invalid_response(self):
+        with server(payload={"version": 42}) as (url, requests):
+            with self.assertRaisesRegex(ValueError, "invalid version"):
+                Shard(url=url).version()
+
+    def test_redirect_does_not_forward_key(self):
+        with server(payload={"version": "unexpected"}) as (destination, requests):
+            with server(status=302, redirect=destination) as (url, source_requests):
+                with self.assertRaisesRegex(RuntimeError, "HTTP 302"):
+                    Shard(url=url, api_key="synthetic-key").version()
+            self.assertEqual(requests, [])
+
+    def test_invalid_url(self):
+        with self.assertRaises(ValueError):
+            Shard(url="file:///tmp/test")
+        with self.assertRaises(ValueError):
+            Shard(url="https://user:password@example.com")