leblob 0.4.0.dev1__tar.gz

leblob-0.4.0.dev1/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.

leblob-0.4.0.dev1/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: leblob
+Version: 0.4.0.dev1
+Summary: An S3-compatible object store
+Author: Stefane Fermigier
+Author-email: Stefane Fermigier <sf@abilian.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: System :: Archiving
+Requires-Dist: awscrt>=0.38.1
+Requires-Dist: cryptography>=44
+Requires-Dist: cyclopts>=5.3.3
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: httptools>=0.6.4
+Requires-Dist: uvicorn>=0.54.0
+Requires-Dist: uvloop>=0.21.0
+Requires-Python: >=3.12
+Project-URL: Repository, https://git.sr.ht/~sfermigier/theblob
+Project-URL: Changelog, https://git.sr.ht/~sfermigier/theblob/tree/main/item/CHANGES.md
+Project-URL: CI, https://builds.sr.ht/~sfermigier/theblob
+Description-Content-Type: text/markdown
+
+# leBLOB
+
+An S3-compatible object store written in Python. It starts as one command on one machine, and is designed to grow into a redundant cluster.
+
+It is meant to replace self-hosted MinIO: single-server installs first, then clusters (not there yet).
+
+## Quick start
+
+```sh
+uv sync
+uv run leblob serve --data-dir ./data
+```
+
+The first start creates an access key and prints it once. Use it with any S3 client:
+
+```python
+import boto3
+
+s3 = boto3.client(
+    "s3",
+    endpoint_url="http://127.0.0.1:9000",
+    aws_access_key_id="...",
+    aws_secret_access_key="...",
+    region_name="us-east-1",
+)
+s3.create_bucket(Bucket="my-bucket")
+s3.put_object(Bucket="my-bucket", Key="hello.txt", Body=b"hello")
+```
+
+Other commands: `leblob key create|list|delete|grant|revoke` and `leblob fsck`. Run `leblob serve --help` for the server options, including TLS and virtual-hosted addressing.
+
+Presigned URLs need SigV4. boto3 presigns with SigV2 by default, which leBLOB refuses, so create the client with `config=Config(signature_version="s3v4")`.
+
+## Moving from MinIO or Garage
+
+With a [rclone](https://rclone.org) remote for each store (`provider = Other`, `force_path_style = true`), and the bucket created on leBLOB:
+
+```sh
+rclone sync --metadata old:my-bucket leblob:my-bucket
+rclone check old:my-bucket leblob:my-bucket
+```
+
+`tests/bench/run_migration.py` checks this from both: the bytes, `Content-Type`, `Cache-Control` and `x-amz-meta-*` arrive, including multipart objects and unusual keys. These don't, and need setting again: object tags, ACLs, lifecycle rules, CORS, keys, and any version but the current one. rclone also adds `mtime` and `btime` to the metadata. An object's time on leBLOB is when it was copied.
+
+## In a container
+
+```sh
+docker build -t leblob .
+docker run -d --name leblob -p 9000:9000 -v leblob-data:/data leblob
+docker logs leblob   # the first start prints an access key once
+```
+
+Set `--workers` after the image name if the default, one per CPU, uses more memory than you want. The data format is upgraded when a newer version starts: back up first, with `leblob backup`. A store written by an earlier release is tested to open in this one, from samples in `tests/upgrade/stores/`.
+
+## Access keys
+
+A key has full access unless it is created as scoped. A scoped key has no rights until it is granted some, per bucket, at one of three levels: `read`, `write` (which includes read) or `admin` (which also allows deleting the bucket).
+
+```sh
+uv run leblob key create --scoped --data-dir ./data
+uv run leblob key grant ACCESS_KEY my-bucket read --data-dir ./data
+uv run leblob key revoke ACCESS_KEY my-bucket --data-dir ./data
+```
+
+A grant or a revocation applies from the next request. A scoped key cannot create buckets, sees only its own buckets when listing, and cannot tell a bucket it has no grant on from one that does not exist. Grants disappear with their bucket, so a bucket deleted and created again starts with none.
+
+## Development
+
+```sh
+make test      # the whole test pyramid
+make lint      # ruff, ty, pyrefly, mypy
+```
+
+Tests are in `tests/`: `a_unit` for pure logic, `b_integration` for real SQLite and files, `c_e2e` for real S3 clients (boto3, AWS CLI, rclone, s5cmd) against a real server over HTTP and HTTPS. The rclone, s5cmd and AWS CLI v2 tests are skipped if those tools are not installed.
+
+## License
+
+Apache-2.0: see `LICENSE`.

leblob-0.4.0.dev1/README.md

@@ -0,0 +1,78 @@
+# leBLOB
+
+An S3-compatible object store written in Python. It starts as one command on one machine, and is designed to grow into a redundant cluster.
+
+It is meant to replace self-hosted MinIO: single-server installs first, then clusters (not there yet).
+
+## Quick start
+
+```sh
+uv sync
+uv run leblob serve --data-dir ./data
+```
+
+The first start creates an access key and prints it once. Use it with any S3 client:
+
+```python
+import boto3
+
+s3 = boto3.client(
+    "s3",
+    endpoint_url="http://127.0.0.1:9000",
+    aws_access_key_id="...",
+    aws_secret_access_key="...",
+    region_name="us-east-1",
+)
+s3.create_bucket(Bucket="my-bucket")
+s3.put_object(Bucket="my-bucket", Key="hello.txt", Body=b"hello")
+```
+
+Other commands: `leblob key create|list|delete|grant|revoke` and `leblob fsck`. Run `leblob serve --help` for the server options, including TLS and virtual-hosted addressing.
+
+Presigned URLs need SigV4. boto3 presigns with SigV2 by default, which leBLOB refuses, so create the client with `config=Config(signature_version="s3v4")`.
+
+## Moving from MinIO or Garage
+
+With a [rclone](https://rclone.org) remote for each store (`provider = Other`, `force_path_style = true`), and the bucket created on leBLOB:
+
+```sh
+rclone sync --metadata old:my-bucket leblob:my-bucket
+rclone check old:my-bucket leblob:my-bucket
+```
+
+`tests/bench/run_migration.py` checks this from both: the bytes, `Content-Type`, `Cache-Control` and `x-amz-meta-*` arrive, including multipart objects and unusual keys. These don't, and need setting again: object tags, ACLs, lifecycle rules, CORS, keys, and any version but the current one. rclone also adds `mtime` and `btime` to the metadata. An object's time on leBLOB is when it was copied.
+
+## In a container
+
+```sh
+docker build -t leblob .
+docker run -d --name leblob -p 9000:9000 -v leblob-data:/data leblob
+docker logs leblob   # the first start prints an access key once
+```
+
+Set `--workers` after the image name if the default, one per CPU, uses more memory than you want. The data format is upgraded when a newer version starts: back up first, with `leblob backup`. A store written by an earlier release is tested to open in this one, from samples in `tests/upgrade/stores/`.
+
+## Access keys
+
+A key has full access unless it is created as scoped. A scoped key has no rights until it is granted some, per bucket, at one of three levels: `read`, `write` (which includes read) or `admin` (which also allows deleting the bucket).
+
+```sh
+uv run leblob key create --scoped --data-dir ./data
+uv run leblob key grant ACCESS_KEY my-bucket read --data-dir ./data
+uv run leblob key revoke ACCESS_KEY my-bucket --data-dir ./data
+```
+
+A grant or a revocation applies from the next request. A scoped key cannot create buckets, sees only its own buckets when listing, and cannot tell a bucket it has no grant on from one that does not exist. Grants disappear with their bucket, so a bucket deleted and created again starts with none.
+
+## Development
+
+```sh
+make test      # the whole test pyramid
+make lint      # ruff, ty, pyrefly, mypy
+```
+
+Tests are in `tests/`: `a_unit` for pure logic, `b_integration` for real SQLite and files, `c_e2e` for real S3 clients (boto3, AWS CLI, rclone, s5cmd) against a real server over HTTP and HTTPS. The rclone, s5cmd and AWS CLI v2 tests are skipped if those tools are not installed.
+
+## License
+
+Apache-2.0: see `LICENSE`.

leblob-0.4.0.dev1/pyproject.toml

@@ -0,0 +1,84 @@
+[project]
+name = "leblob"
+version = "0.4.0.dev1"
+description = "An S3-compatible object store"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Web Environment",
+    "Intended Audience :: System Administrators",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: System :: Archiving",
+]
+dependencies = [
+    "awscrt>=0.38.1",
+    "cryptography>=44",
+    "cyclopts>=5.3.3",
+    "defusedxml>=0.7.1",
+    "httptools>=0.6.4",
+    "uvicorn>=0.54.0",
+    "uvloop>=0.21.0",
+]
+
+[[project.authors]]
+name = "Stefane Fermigier"
+email = "sf@abilian.com"
+
+[project.urls]
+Repository = "https://git.sr.ht/~sfermigier/theblob"
+Changelog = "https://git.sr.ht/~sfermigier/theblob/tree/main/item/CHANGES.md"
+CI = "https://builds.sr.ht/~sfermigier/theblob"
+
+[project.scripts]
+leblob = "leblob.cli:app"
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "anyio>=4.16.0",
+    "awscli>=1.46.2",
+    "boto3>=1.43.124",
+    "httpx>=0.28.1",
+    "mypy>=2.4.1",
+    "nox>=2026.10.20",
+    "pre-commit>=4.7.0",
+    "prometheus-client>=0.26.0",
+    "pyrefly>=1.4.1",
+    "pytest>=9.2.0",
+    "pytest-cov>=7.1.0",
+    "pytest-timeout>=2.4.0",
+    "ruff>=0.17.3",
+    "ty>=0.0.97",
+    "types-defusedxml>=0.7.0.20260504",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+timeout = 120
+tmp_path_retention_policy = "failed"
+markers = [
+    "unit: fast tests of pure logic, no I/O",
+    "integration: components against real SQLite and real files",
+    "e2e: real S3 clients against a real server process",
+    "slow: takes more than a few seconds",
+]
+
+[tool.mypy]
+mypy_path = "stubs"
+
+[tool.pyrefly]
+project-includes = [
+    "**/*.py*",
+    "**/*.ipynb",
+]

leblob-0.4.0.dev1/pyproject.toml.orig

@@ -0,0 +1,85 @@
+[project]
+name = "leblob"
+version = "0.4.0.dev1"
+description = "An S3-compatible object store"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Stefane Fermigier", email = "sf@abilian.com" }
+]
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Web Environment",
+    "Intended Audience :: System Administrators",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: System :: Archiving",
+]
+dependencies = [
+    "awscrt>=0.38.1",
+    "cryptography>=44",
+    "cyclopts>=5.3.3",
+    "defusedxml>=0.7.1",
+    "httptools>=0.6.4",
+    "uvicorn>=0.54.0",
+    "uvloop>=0.21.0",
+]
+
+[project.urls]
+Repository = "https://git.sr.ht/~sfermigier/theblob"
+Changelog = "https://git.sr.ht/~sfermigier/theblob/tree/main/item/CHANGES.md"
+CI = "https://builds.sr.ht/~sfermigier/theblob"
+
+[project.scripts]
+leblob = "leblob.cli:app"
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "anyio>=4.16.0",
+    "awscli>=1.46.2",
+    "boto3>=1.43.124",
+    "httpx>=0.28.1",
+    "mypy>=2.4.1",
+    "nox>=2026.10.20",
+    "pre-commit>=4.7.0",
+    "prometheus-client>=0.26.0",
+    "pyrefly>=1.4.1",
+    "pytest>=9.2.0",
+    "pytest-cov>=7.1.0",
+    "pytest-timeout>=2.4.0",
+    "ruff>=0.17.3",
+    "ty>=0.0.97",
+    "types-defusedxml>=0.7.0.20260504",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+timeout = 120
+# A store is thousands of directories: kept, a few sessions use up a disk's inodes.
+tmp_path_retention_policy = "failed"
+markers = [
+    "unit: fast tests of pure logic, no I/O",
+    "integration: components against real SQLite and real files",
+    "e2e: real S3 clients against a real server process",
+    "slow: takes more than a few seconds",
+]
+
+[tool.mypy]
+# awscrt ships no type information.
+mypy_path = "stubs"
+
+[tool.pyrefly]
+project-includes = [
+    "**/*.py*",
+    "**/*.ipynb",
+]

leblob-0.4.0.dev1/src/leblob/__init__.py

@@ -0,0 +1 @@
+"""leblob: an S3-compatible object store."""