bucklet 0.1.0__tar.gz

bucklet-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: bucklet
+Version: 0.1.0
+Summary: Manage S3 objects in any storage class.
+Keywords: s3,glacier,deep-archive,tui,cli,backup
+Author: Tomas Vana
+License-Expression: MIT
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Archiving :: Backup
+Requires-Dist: argcomplete>=3.6.3
+Requires-Dist: boto3>=1.43.18
+Requires-Dist: platformdirs>=4.10.0
+Requires-Dist: textual>=8.2.7
+Requires-Python: >=3.10
+Project-URL: Repository, https://github.com/tomasvana/bucklet
+Description-Content-Type: text/markdown
+
+# bucklet
+
+Bucklet is a small CLI/TUI tool for managing objects in S3 compatible buckets, with support for all storage classes.
+
+## Install
+
+Python >=3.10 is required.
+
+1. Install the `bucklet` package from PyPI:
+
+```bash
+# using pipx
+pipx ensurepath && pipx install bucklet
+
+# using uv
+uv tool install bucklet
+```
+
+2. Optionally, install shell completion:
+
+```bash
+# fish
+register-python-argcomplete --shell fish bucklet > ~/.config/fish/completions/bucklet.fish
+
+# bash
+echo 'eval "$(register-python-argcomplete bucklet)"' >> ~/.bashrc
+
+# zsh
+echo 'autoload -U compinit bashcompinit && compinit && bashcompinit; eval "$(register-python-argcomplete bucklet)"' >> ~/.zshrc
+
+# PowerShell
+Add-Content $PROFILE 'register-python-argcomplete --shell powershell bucklet | Out-String | Invoke-Expression'
+```
+
+3. Run `bucklet` to open the TUI and configure a profile with your S3 credentials.
+
+> [!IMPORTANT]
+> Deletion of objects is only supported through the TUI when launched with the `--allow-deletion` flag.
+
+## Usage
+
+```
+bucklet [-h] [--profile NAME] [--allow-deletion] {up,get,thaw,ls,stat,profile} ...
+
+positional arguments:
+  {up,get,thaw,ls,stat,profile}
+    up                  upload files/dirs (mirrors absolute path)
+    get                 download objects (globs allowed)
+    thaw                restore archived objects (globs allowed)
+    ls                  list objects
+    stat                show detailed status of objects (globs allowed)
+    profile             manage saved profiles
+
+options:
+  -h, --help            show this help message and exit
+  --profile NAME        profile to use (a saved name, or a raw bucket name); defaults to the configured default profile
+  --allow-deletion      allow deleting objects in the TUI (no effect on the subcommands)
+```
+
+## Development
+
+Set up the environment:
+
+```bash
+uv sync
+pre-commit install
+```
+
+Test the project:
+
+```bash
+uv run pytest
+uv run pytest --cov=bucklet
+```
+
+Run the project:
+
+```bash
+uv run bucklet
+```

bucklet-0.1.0/README.md

@@ -0,0 +1,80 @@
+# bucklet
+
+Bucklet is a small CLI/TUI tool for managing objects in S3 compatible buckets, with support for all storage classes.
+
+## Install
+
+Python >=3.10 is required.
+
+1. Install the `bucklet` package from PyPI:
+
+```bash
+# using pipx
+pipx ensurepath && pipx install bucklet
+
+# using uv
+uv tool install bucklet
+```
+
+2. Optionally, install shell completion:
+
+```bash
+# fish
+register-python-argcomplete --shell fish bucklet > ~/.config/fish/completions/bucklet.fish
+
+# bash
+echo 'eval "$(register-python-argcomplete bucklet)"' >> ~/.bashrc
+
+# zsh
+echo 'autoload -U compinit bashcompinit && compinit && bashcompinit; eval "$(register-python-argcomplete bucklet)"' >> ~/.zshrc
+
+# PowerShell
+Add-Content $PROFILE 'register-python-argcomplete --shell powershell bucklet | Out-String | Invoke-Expression'
+```
+
+3. Run `bucklet` to open the TUI and configure a profile with your S3 credentials.
+
+> [!IMPORTANT]
+> Deletion of objects is only supported through the TUI when launched with the `--allow-deletion` flag.
+
+## Usage
+
+```
+bucklet [-h] [--profile NAME] [--allow-deletion] {up,get,thaw,ls,stat,profile} ...
+
+positional arguments:
+  {up,get,thaw,ls,stat,profile}
+    up                  upload files/dirs (mirrors absolute path)
+    get                 download objects (globs allowed)
+    thaw                restore archived objects (globs allowed)
+    ls                  list objects
+    stat                show detailed status of objects (globs allowed)
+    profile             manage saved profiles
+
+options:
+  -h, --help            show this help message and exit
+  --profile NAME        profile to use (a saved name, or a raw bucket name); defaults to the configured default profile
+  --allow-deletion      allow deleting objects in the TUI (no effect on the subcommands)
+```
+
+## Development
+
+Set up the environment:
+
+```bash
+uv sync
+pre-commit install
+```
+
+Test the project:
+
+```bash
+uv run pytest
+uv run pytest --cov=bucklet
+```
+
+Run the project:
+
+```bash
+uv run bucklet
+```

bucklet-0.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "bucklet"
+version = "0.1.0"
+description = "Manage S3 objects in any storage class."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [{ name = "Tomas Vana" }]
+keywords = ["s3", "glacier", "deep-archive", "tui", "cli", "backup"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: System :: Archiving :: Backup",
+]
+dependencies = [
+    "argcomplete>=3.6.3",
+    "boto3>=1.43.18",
+    "platformdirs>=4.10.0",
+    "textual>=8.2.7",
+]
+
+[project.scripts]
+bucklet = "bucklet.cli:main"
+
+[project.urls]
+Repository = "https://github.com/tomasvana/bucklet"
+
+[build-system]
+requires = ["uv_build>=0.11.2,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+asyncio_mode = "auto"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W", "UP", "B"]
+
+[dependency-groups]
+dev = [
+    "moto[s3]>=5.2.1",
+    "pre-commit>=4.6.0",
+    "pytest>=9.0.3",
+    "pytest-asyncio>=1.4.0",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.15.15",
+]

bucklet-0.1.0/src/bucklet/__init__.py

@@ -0,0 +1,18 @@
+""" "Manage S3 objects in any storage class."
+
+The CLI and the Textual TUI are thin frontends over one UI-agnostic core
+(:mod:`bucklet.service`). The modules underneath it are:
+
+    bucklet.storage   storage-class vocabulary and object-state logic (pure)
+    bucklet.models    the Profile, ObjectInfo and ObjectStatus dataclasses
+    bucklet.rclone    reads credentials from an rclone remote
+    bucklet.config    saved profiles and the default selection
+    bucklet.s3        thin boto3 wrappers that raise BuckletError
+    bucklet.service   the high-level operations both front-ends call
+    bucklet.cli       the argparse front-end
+    bucklet.tui       the Textual front-end
+"""
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

bucklet-0.1.0/src/bucklet/__main__.py

@@ -0,0 +1,8 @@
+"""Run bucklet with ``python -m bucklet``."""
+
+import sys
+
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())