openbucket-client 0.1.1__tar.gz

openbucket_client-0.1.1/.gitignore

@@ -0,0 +1,67 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+/.tmp/
+/tmp*/
+/.openbucket-data/
+
+# next.js
+/.next/
+/.vinext/
+/out/
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+!.env.example
+
+# vercel
+.vercel
+
+# typescript
+next-env.d.ts
+/dist/
+/vercel-dist/
+/.wrangler/
+/outputs/
+/work/
+*.tsbuildinfo
+
+# Python build/test environments
+**/__pycache__/
+*.py[cod]
+/.venv/
+/python/.venv/
+/python/.pytest_cache/
+/python/.mypy_cache/
+/python/.ruff_cache/
+**/.tox/
+**/.coverage
+/python/build/
+/python/dist/
+**/*.egg-info/
+coverage.xml
+
+# release artifacts
+/.release/
+/openbucket-*.tgz

openbucket_client-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 OpenBucket contributors
+
+   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.

openbucket_client-0.1.1/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: openbucket-client
+Version: 0.1.1
+Summary: Typed, dependency-free Python client for the OpenBucket management API
+Project-URL: Homepage, https://github.com/Razin-developer/openbucket
+Project-URL: Source, https://github.com/Razin-developer/openbucket
+Project-URL: Documentation, https://github.com/Razin-developer/openbucket/tree/main/docs
+Project-URL: Issues, https://github.com/Razin-developer/openbucket/issues
+Author: OpenBucket contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api-client,object-storage,openbucket,s3,storage
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == 'dev'
+Requires-Dist: mypy<2,>=1.10; extra == 'dev'
+Requires-Dist: ruff<1,>=0.9; extra == 'dev'
+Requires-Dist: tox<5,>=4.20; extra == 'dev'
+Requires-Dist: twine<7,>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# OpenBucket Python client
+
+`openbucket-client` is the typed, dependency-free Python client for a running
+[OpenBucket](https://github.com/Razin-developer/openbucket) management API. It supports Python 3.10+
+and uses only the standard library at runtime.
+
+This package is a client, not a Python implementation of the OpenBucket daemon.
+Start the OpenBucket daemon separately, then point this client at its management
+URL. Object data is stored and served by that daemon.
+
+## Install
+
+`openbucket-client` is not on PyPI yet. Install it from a checked-out OpenBucket repository:
+
+```bash
+python -m pip install ./python
+```
+
+After the first unified `0.1.1` release is visible on PyPI:
+
+```bash
+python -m pip install openbucket-client==0.1.1
+pipx install openbucket-client==0.1.1
+# or
+uv tool install openbucket-client==0.1.1
+```
+
+The distribution is named `openbucket-client`; the import package is
+`openbucket`.
+
+## Python API
+
+```python
+import os
+
+from openbucket import OpenBucketClient
+
+client = OpenBucketClient(
+    os.environ.get("OPENBUCKET_API_URL", "http://127.0.0.1:7272"),
+    os.environ["OPENBUCKET_ADMIN_TOKEN"],
+)
+
+print(client.status().storage.free_bytes)
+
+bucket = client.create_bucket("project-assets")
+uploaded = client.upload_file(
+    bucket.name,
+    "images/logo.svg",
+    "logo.svg",
+    content_type="image/svg+xml",
+)
+print(uploaded.etag)
+
+share = client.create_share(bucket.name, uploaded.key, expires_in=3600)
+print(share.url)
+```
+
+The client exposes immutable typed models and methods for:
+
+- daemon health, status, endpoints, and client configuration;
+- bucket creation, visibility, listing, and deletion;
+- object listing, streaming upload, download, metadata, and deletion;
+- S3 access-key creation, listing, and revocation;
+- expiring share URL creation;
+- request logs, analytics, and graceful daemon stop.
+
+`upload_file()` streams from disk. `download_to()` streams to disk, uses an
+exclusive create by default, and can atomically replace a destination with
+`overwrite=True`. `download_object()` returns bytes and accepts `max_bytes` when
+the caller needs a memory safety bound.
+
+## Error handling
+
+```python
+from openbucket import OpenBucketHTTPError
+
+try:
+    client.create_bucket("already-present")
+except OpenBucketHTTPError as error:
+    print(error.status)      # 409
+    print(error.code)        # BucketAlreadyExists
+    print(error.request_id)  # request correlation ID, when provided
+```
+
+Transport, protocol, configuration, and HTTP failures have separate exception
+types. The client does not follow redirects, preventing a management bearer
+token from being forwarded to another origin.
+
+## Command line
+
+Set credentials in the environment so the token does not appear in shell
+history or the process list:
+
+```bash
+export OPENBUCKET_API_URL=http://127.0.0.1:7272
+export OPENBUCKET_ADMIN_TOKEN='replace-with-the-daemon-token'
+
+openbucket-client status
+openbucket-client buckets list
+openbucket-client buckets create project-assets
+openbucket-client objects upload project-assets images/logo.svg ./logo.svg
+openbucket-client objects download project-assets images/logo.svg ./downloaded.svg
+openbucket-client share project-assets images/logo.svg --expires-in 3600
+openbucket-client --json analytics
+```
+
+Use `openbucket-client --help` for the complete command tree. `--token` exists
+for automation environments that cannot inject variables, but the environment
+variable is safer for interactive use.
+
+## TLS and remote use
+
+Use an HTTPS management URL for any connection that leaves localhost or a
+trusted private network. The bearer token grants full management access. Do not
+embed it in browser code, logs, container images, or source control. Python uses
+the platform/default CA trust store and honors the standard proxy environment
+variables.
+
+## Development and verification
+
+The test suite performs real loopback HTTP requests against a threaded local
+HTTP server; it does not patch or mock `urllib`.
+
+```bash
+cd python
+python -m unittest discover -s tests -v
+python -m pip install -e '.[dev]'
+ruff check .
+mypy src/openbucket
+python -m build
+twine check dist/*
+python -m pip install --force-reinstall dist/openbucket_client-0.1.1-py3-none-any.whl
+openbucket-client --version
+```
+
+`tox` verifies the built wheel on every locally installed Python version from
+3.10 through 3.14:
+
+```bash
+tox
+```
+
+Licensed under Apache-2.0. See [LICENSE](LICENSE).

openbucket_client-0.1.1/README.md

@@ -0,0 +1,143 @@
+# OpenBucket Python client
+
+`openbucket-client` is the typed, dependency-free Python client for a running
+[OpenBucket](https://github.com/Razin-developer/openbucket) management API. It supports Python 3.10+
+and uses only the standard library at runtime.
+
+This package is a client, not a Python implementation of the OpenBucket daemon.
+Start the OpenBucket daemon separately, then point this client at its management
+URL. Object data is stored and served by that daemon.
+
+## Install
+
+`openbucket-client` is not on PyPI yet. Install it from a checked-out OpenBucket repository:
+
+```bash
+python -m pip install ./python
+```
+
+After the first unified `0.1.1` release is visible on PyPI:
+
+```bash
+python -m pip install openbucket-client==0.1.1
+pipx install openbucket-client==0.1.1
+# or
+uv tool install openbucket-client==0.1.1
+```
+
+The distribution is named `openbucket-client`; the import package is
+`openbucket`.
+
+## Python API
+
+```python
+import os
+
+from openbucket import OpenBucketClient
+
+client = OpenBucketClient(
+    os.environ.get("OPENBUCKET_API_URL", "http://127.0.0.1:7272"),
+    os.environ["OPENBUCKET_ADMIN_TOKEN"],
+)
+
+print(client.status().storage.free_bytes)
+
+bucket = client.create_bucket("project-assets")
+uploaded = client.upload_file(
+    bucket.name,
+    "images/logo.svg",
+    "logo.svg",
+    content_type="image/svg+xml",
+)
+print(uploaded.etag)
+
+share = client.create_share(bucket.name, uploaded.key, expires_in=3600)
+print(share.url)
+```
+
+The client exposes immutable typed models and methods for:
+
+- daemon health, status, endpoints, and client configuration;
+- bucket creation, visibility, listing, and deletion;
+- object listing, streaming upload, download, metadata, and deletion;
+- S3 access-key creation, listing, and revocation;
+- expiring share URL creation;
+- request logs, analytics, and graceful daemon stop.
+
+`upload_file()` streams from disk. `download_to()` streams to disk, uses an
+exclusive create by default, and can atomically replace a destination with
+`overwrite=True`. `download_object()` returns bytes and accepts `max_bytes` when
+the caller needs a memory safety bound.
+
+## Error handling
+
+```python
+from openbucket import OpenBucketHTTPError
+
+try:
+    client.create_bucket("already-present")
+except OpenBucketHTTPError as error:
+    print(error.status)      # 409
+    print(error.code)        # BucketAlreadyExists
+    print(error.request_id)  # request correlation ID, when provided
+```
+
+Transport, protocol, configuration, and HTTP failures have separate exception
+types. The client does not follow redirects, preventing a management bearer
+token from being forwarded to another origin.
+
+## Command line
+
+Set credentials in the environment so the token does not appear in shell
+history or the process list:
+
+```bash
+export OPENBUCKET_API_URL=http://127.0.0.1:7272
+export OPENBUCKET_ADMIN_TOKEN='replace-with-the-daemon-token'
+
+openbucket-client status
+openbucket-client buckets list
+openbucket-client buckets create project-assets
+openbucket-client objects upload project-assets images/logo.svg ./logo.svg
+openbucket-client objects download project-assets images/logo.svg ./downloaded.svg
+openbucket-client share project-assets images/logo.svg --expires-in 3600
+openbucket-client --json analytics
+```
+
+Use `openbucket-client --help` for the complete command tree. `--token` exists
+for automation environments that cannot inject variables, but the environment
+variable is safer for interactive use.
+
+## TLS and remote use
+
+Use an HTTPS management URL for any connection that leaves localhost or a
+trusted private network. The bearer token grants full management access. Do not
+embed it in browser code, logs, container images, or source control. Python uses
+the platform/default CA trust store and honors the standard proxy environment
+variables.
+
+## Development and verification
+
+The test suite performs real loopback HTTP requests against a threaded local
+HTTP server; it does not patch or mock `urllib`.
+
+```bash
+cd python
+python -m unittest discover -s tests -v
+python -m pip install -e '.[dev]'
+ruff check .
+mypy src/openbucket
+python -m build
+twine check dist/*
+python -m pip install --force-reinstall dist/openbucket_client-0.1.1-py3-none-any.whl
+openbucket-client --version
+```
+
+`tox` verifies the built wheel on every locally installed Python version from
+3.10 through 3.14:
+
+```bash
+tox
+```
+
+Licensed under Apache-2.0. See [LICENSE](LICENSE).

openbucket_client-0.1.1/pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ["hatchling>=1.27,<2"]
+build-backend = "hatchling.build"
+
+[project]
+name = "openbucket-client"
+version = "0.1.1"
+description = "Typed, dependency-free Python client for the OpenBucket management API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "OpenBucket contributors" }]
+keywords = ["openbucket", "object-storage", "s3", "storage", "api-client"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Typing :: Typed",
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2,<2",
+  "mypy>=1.10,<2",
+  "ruff>=0.9,<1",
+  "tox>=4.20,<5",
+  "twine>=6,<7",
+]
+
+[project.scripts]
+openbucket-client = "openbucket.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/Razin-developer/openbucket"
+Source = "https://github.com/Razin-developer/openbucket"
+Documentation = "https://github.com/Razin-developer/openbucket/tree/main/docs"
+Issues = "https://github.com/Razin-developer/openbucket/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/openbucket"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src/openbucket",
+  "/tests",
+  "/README.md",
+  "/LICENSE",
+  "/pyproject.toml",
+  "/tox.ini",
+]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+files = ["src/openbucket"]