compose-lazy 0.7.0__tar.gz

compose_lazy-0.7.0/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Hiro Ito
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

compose_lazy-0.7.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: compose-lazy
+Version: 0.7.0
+Summary: A smart CLI wrapper for docker compose with interactive selection support.
+Keywords: docker,docker compose,alias,command line tool,productivity
+Author-email: Hiro Ito <mobiiii24@gmail.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Topic :: Utilities
+Classifier: Environment :: Console
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0.3
+Project-URL: Issues, https://github.com/HiroItozzz/compose-lazy/issues
+Project-URL: Repository, https://github.com/HiroItozzz/compose-lazy
+
+# Compose Lazy
+> 🚀 A smart CLI wrapper for `docker compose` — with interactive file, profile, and service selection.
+
+## Overview
+A CLI tool designed to streamline workflows for developers who frequently use `docker compose`.  
+In addition to short aliases for common commands, it features interactive selection of compose files, profiles, and services, and multi-repository workspace management.   
+Available on PyPI — install instantly with `pipx install compose-lazy` or `uv tool install compose-lazy`.
+
+[日本語版README](README_ja.md)もあります。
+
+## Highlights
+
+### Basic Commands
+Installing compose-lazy adds three commands to your PATH automatically.
+
+| Command | Description |
+|---|---|
+| `dcpu` | Alias for `docker compose up` |
+| `dcpe` | Alias for `docker compose exec` |
+| `dcp` | Alias for other subcommands (`build`, `logs`, `stop`, etc.) |
+
+Each command supports multiple options. See the [List of Commands](#list-of-commands) for details.
+
+
+### Multi-Repo Workspace
+Register named groups of repositories as a *workspace* and operate all of them at once.
+ 
+```bash
+# Register repositories to a workspace
+$ dcp ws register
+Please enter a new directory path: /path/to/repo
+Please enter a new workspace name: myproject
+☑ Registered new path to myproject: /path/to/repo
+ 
+# Launch all repos in a workspace
+$ dcp ws up
+☑ Found 1 registered workspace.
+    1. myproject
+Enter your choice: 1
+▷ Executing `docker compose up -d` in `/path/to/repo`.
+```
+ 
+Workspace configuration is stored in `~/.config/compose-lazy`.
+
+
+### Interactive Selection
+Running `-f`, `-pf`, or `-s` without arguments auto-detects compose files, profiles, and services, letting you choose interactively.
+
+```bash
+$ dcpu -f
+☑ Found 2 compose files!
+    1. docker-compose.yml
+    2. docker-compose.prod.yml
+Enter your choices (e.g., 1,3,4) or 'q' to quit: 2
+▷ Executing `docker compose -f docker-compose.prod.yml up`.
+
+$ dcp re -pf   # `re`start
+☑ Found 2 profiles!
+    1. dev
+    2. prod
+Enter your choices (e.g., 1,3,4) or 'q' to quit: 1
+▷ Executing `docker compose --profile dev restart`.
+
+$ dcp l -s   # `l`ogs
+☑ Found 3 services!
+    1. app
+    2. db
+    3. frontend
+Enter your choices (e.g., 1,3,4) or 'q' to quit: 1,2
+▷ Executing `docker compose logs app db`.
+```
+
+For `exec`/`run`, interactive selection starts automatically when no service name is given.
+
+```bash
+$ dcpe   # `e`xec
+☑ Found 3 services!
+    1. app
+    2. db
+    3. frontend
+Enter your choice or 'q' to quit: 1
+▷ Executing `docker compose exec app bash`.
+```
+
+
+## 🔧 Install compose-lazy
+### Quick Install
+```bash
+# Using pipx
+pipx install compose-lazy
+# OR using uv
+uv tool install compose-lazy
+```
+### Not familiar with Python tooling?
+
+If you don't have `pipx` or `uv` installed yet:
+
+<details>
+<summary>Windows</summary>
+
+```bash
+python -m pip install --user pipx
+python -m pipx ensurepath
+# Restart terminal, then:
+pipx install compose-lazy
+```
+</details>
+
+<details>
+<summary>macOS</summary>
+
+```bash
+brew install pipx
+pipx ensurepath
+pipx install compose-lazy
+```
+</details>
+
+<details>
+<summary>Linux (Ubuntu/Debian)</summary>
+
+```bash
+pip install pipx
+pipx ensurepath
+pipx install compose-lazy
+```
+</details>
+
+## Features
+
+- **Interactive Selection**: auto-detect and interactively select compose files, profiles, and services
+- **Multi-Repo Workspace**: run docker compose commands across multiple repositories at once with `dcp ws`
+- **Short Aliases**: `dcp u`, `dcp b`, `dcp e` — fewer keystrokes for common commands
+- **Dedicated Commands**: `dcpu` and `dcpe` for frequent up/exec workflows
+- **Cross-Platform**: Works on Windows, macOS, and Linux
+
+## FAQ
+### Why use pipx or uv tool instead of pip?
+
+Both `pipx` and `uv tool` install CLI tools in isolated environments, so compose-lazy won't conflict with other Python packages. The commands (`dcp`, `dcpu`, `dcpe`) are available globally without activating a virtual environment. `uv tool` is the faster alternative if you already use uv.
+
+## Requirements
+
+- Python 3.11+
+- Docker with Compose V2 (`docker compose` — not `docker-compose`)
+- A `docker-compose.yml` (or `*compose*.yml/yaml`) in the current directory for interactive selection features
+
+## List of Commands
+
+> **Common options** (available for all commands): `-s`, `-f FILE...`, `-pf PROFILE...`, `-p PROJECT`
+>
+> ⚠️ Note: `-f`, `-pf`, `-p` are passed before the subcommand in the actual docker compose syntax,  
+> but in compose-lazy they are specified after the subcommand (e.g. `dcp up -f FILE`).
+
+| Bash Command                         | Executed Docker Command                                  |
+|--------------------------------------|----------------------------------------------------------|
+| dcp                                  | - (Show help)                                            |
+| dcpu [SERVICE...] [-d] [-b] [-w]     | docker compose up [SERVICE...]                           |
+| dcpe [SERVICE]                       | docker compose exec SERVICE bash                         |
+| dcpe [SERVICE] [COMMANDS...]         | docker compose exec SERVICE [COMMANDS...]                |
+| dcp up(u) [SERVICE...]               | docker compose up [SERVICE...]                           |
+| dcp up(u) -d                         | docker compose up -d                                     |
+| dcp up(u) -b                         | docker compose up --build                                |
+| dcp up(u) -w                         | docker compose up --wait                                 |
+| dcp build(b) [SERVICE...]            | docker compose build [SERVICE...]                        |
+| dcp exec(e) [SERVICE]                | docker compose exec SERVICE bash                         |
+| dcp exec(e) [SERVICE] [COMMANDS...]  | docker compose exec SERVICE [COMMANDS...]           |
+| dcp run [SERVICE]                    | docker compose run SERVICE bash                          |
+| dcp restart(re) [SERVICE...]         | docker compose restart [SERVICE...]                      |
+| dcp ps [SERVICE...] [-a] [-st STATUS]| docker compose ps [SERVICE...] [--all] [--status ...]    |
+| dcp logs(l) [SERVICE...] [-fo]       | docker compose logs [SERVICE...] [-f]                    |
+| dcp stop(s) [SERVICE...]             | docker compose stop [SERVICE...]                         |
+| dcp down [-ro]                       | docker compose down [--remove-orphans]                   |
+| dcp workspace(ws) register(reg)      | Register a new repo to a workspace interactively         |
+| dcp workspace(ws) delete(del)        | Delete a repo from a workspace interactively             |
+| dcp workspace(ws) list(li)           | List all registered workspaces                           |
+| dcp workspace(ws) up(u)              | docker compose up -d for each repo in a workspace        |
+| dcp workspace(ws) restart(re)        | docker compose restart for each repo in a workspace      |
+| dcp workspace(ws) stop(s)            | docker compose stop for each repo in a workspace         |
+| dcp workspace(ws) down               | docker compose down for each repo in a workspace         |
+
+and more... see `dcp --help` for the full list of supported commands and options.
+
+## License
+
+MIT LICENSE

compose_lazy-0.7.0/README.md

@@ -0,0 +1,186 @@
+# Compose Lazy
+> 🚀 A smart CLI wrapper for `docker compose` — with interactive file, profile, and service selection.
+
+## Overview
+A CLI tool designed to streamline workflows for developers who frequently use `docker compose`.  
+In addition to short aliases for common commands, it features interactive selection of compose files, profiles, and services, and multi-repository workspace management.   
+Available on PyPI — install instantly with `pipx install compose-lazy` or `uv tool install compose-lazy`.
+
+[日本語版README](README_ja.md)もあります。
+
+## Highlights
+
+### Basic Commands
+Installing compose-lazy adds three commands to your PATH automatically.
+
+| Command | Description |
+|---|---|
+| `dcpu` | Alias for `docker compose up` |
+| `dcpe` | Alias for `docker compose exec` |
+| `dcp` | Alias for other subcommands (`build`, `logs`, `stop`, etc.) |
+
+Each command supports multiple options. See the [List of Commands](#list-of-commands) for details.
+
+
+### Multi-Repo Workspace
+Register named groups of repositories as a *workspace* and operate all of them at once.
+ 
+```bash
+# Register repositories to a workspace
+$ dcp ws register
+Please enter a new directory path: /path/to/repo
+Please enter a new workspace name: myproject
+☑ Registered new path to myproject: /path/to/repo
+ 
+# Launch all repos in a workspace
+$ dcp ws up
+☑ Found 1 registered workspace.
+    1. myproject
+Enter your choice: 1
+▷ Executing `docker compose up -d` in `/path/to/repo`.
+```
+ 
+Workspace configuration is stored in `~/.config/compose-lazy`.
+
+
+### Interactive Selection
+Running `-f`, `-pf`, or `-s` without arguments auto-detects compose files, profiles, and services, letting you choose interactively.
+
+```bash
+$ dcpu -f
+☑ Found 2 compose files!
+    1. docker-compose.yml
+    2. docker-compose.prod.yml
+Enter your choices (e.g., 1,3,4) or 'q' to quit: 2
+▷ Executing `docker compose -f docker-compose.prod.yml up`.
+
+$ dcp re -pf   # `re`start
+☑ Found 2 profiles!
+    1. dev
+    2. prod
+Enter your choices (e.g., 1,3,4) or 'q' to quit: 1
+▷ Executing `docker compose --profile dev restart`.
+
+$ dcp l -s   # `l`ogs
+☑ Found 3 services!
+    1. app
+    2. db
+    3. frontend
+Enter your choices (e.g., 1,3,4) or 'q' to quit: 1,2
+▷ Executing `docker compose logs app db`.
+```
+
+For `exec`/`run`, interactive selection starts automatically when no service name is given.
+
+```bash
+$ dcpe   # `e`xec
+☑ Found 3 services!
+    1. app
+    2. db
+    3. frontend
+Enter your choice or 'q' to quit: 1
+▷ Executing `docker compose exec app bash`.
+```
+
+
+## 🔧 Install compose-lazy
+### Quick Install
+```bash
+# Using pipx
+pipx install compose-lazy
+# OR using uv
+uv tool install compose-lazy
+```
+### Not familiar with Python tooling?
+
+If you don't have `pipx` or `uv` installed yet:
+
+<details>
+<summary>Windows</summary>
+
+```bash
+python -m pip install --user pipx
+python -m pipx ensurepath
+# Restart terminal, then:
+pipx install compose-lazy
+```
+</details>
+
+<details>
+<summary>macOS</summary>
+
+```bash
+brew install pipx
+pipx ensurepath
+pipx install compose-lazy
+```
+</details>
+
+<details>
+<summary>Linux (Ubuntu/Debian)</summary>
+
+```bash
+pip install pipx
+pipx ensurepath
+pipx install compose-lazy
+```
+</details>
+
+## Features
+
+- **Interactive Selection**: auto-detect and interactively select compose files, profiles, and services
+- **Multi-Repo Workspace**: run docker compose commands across multiple repositories at once with `dcp ws`
+- **Short Aliases**: `dcp u`, `dcp b`, `dcp e` — fewer keystrokes for common commands
+- **Dedicated Commands**: `dcpu` and `dcpe` for frequent up/exec workflows
+- **Cross-Platform**: Works on Windows, macOS, and Linux
+
+## FAQ
+### Why use pipx or uv tool instead of pip?
+
+Both `pipx` and `uv tool` install CLI tools in isolated environments, so compose-lazy won't conflict with other Python packages. The commands (`dcp`, `dcpu`, `dcpe`) are available globally without activating a virtual environment. `uv tool` is the faster alternative if you already use uv.
+
+## Requirements
+
+- Python 3.11+
+- Docker with Compose V2 (`docker compose` — not `docker-compose`)
+- A `docker-compose.yml` (or `*compose*.yml/yaml`) in the current directory for interactive selection features
+
+## List of Commands
+
+> **Common options** (available for all commands): `-s`, `-f FILE...`, `-pf PROFILE...`, `-p PROJECT`
+>
+> ⚠️ Note: `-f`, `-pf`, `-p` are passed before the subcommand in the actual docker compose syntax,  
+> but in compose-lazy they are specified after the subcommand (e.g. `dcp up -f FILE`).
+
+| Bash Command                         | Executed Docker Command                                  |
+|--------------------------------------|----------------------------------------------------------|
+| dcp                                  | - (Show help)                                            |
+| dcpu [SERVICE...] [-d] [-b] [-w]     | docker compose up [SERVICE...]                           |
+| dcpe [SERVICE]                       | docker compose exec SERVICE bash                         |
+| dcpe [SERVICE] [COMMANDS...]         | docker compose exec SERVICE [COMMANDS...]                |
+| dcp up(u) [SERVICE...]               | docker compose up [SERVICE...]                           |
+| dcp up(u) -d                         | docker compose up -d                                     |
+| dcp up(u) -b                         | docker compose up --build                                |
+| dcp up(u) -w                         | docker compose up --wait                                 |
+| dcp build(b) [SERVICE...]            | docker compose build [SERVICE...]                        |
+| dcp exec(e) [SERVICE]                | docker compose exec SERVICE bash                         |
+| dcp exec(e) [SERVICE] [COMMANDS...]  | docker compose exec SERVICE [COMMANDS...]           |
+| dcp run [SERVICE]                    | docker compose run SERVICE bash                          |
+| dcp restart(re) [SERVICE...]         | docker compose restart [SERVICE...]                      |
+| dcp ps [SERVICE...] [-a] [-st STATUS]| docker compose ps [SERVICE...] [--all] [--status ...]    |
+| dcp logs(l) [SERVICE...] [-fo]       | docker compose logs [SERVICE...] [-f]                    |
+| dcp stop(s) [SERVICE...]             | docker compose stop [SERVICE...]                         |
+| dcp down [-ro]                       | docker compose down [--remove-orphans]                   |
+| dcp workspace(ws) register(reg)      | Register a new repo to a workspace interactively         |
+| dcp workspace(ws) delete(del)        | Delete a repo from a workspace interactively             |
+| dcp workspace(ws) list(li)           | List all registered workspaces                           |
+| dcp workspace(ws) up(u)              | docker compose up -d for each repo in a workspace        |
+| dcp workspace(ws) restart(re)        | docker compose restart for each repo in a workspace      |
+| dcp workspace(ws) stop(s)            | docker compose stop for each repo in a workspace         |
+| dcp workspace(ws) down               | docker compose down for each repo in a workspace         |
+
+and more... see `dcp --help` for the full list of supported commands and options.
+
+## License
+
+MIT LICENSE

compose_lazy-0.7.0/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["flit_core >= 3.12.0, <5"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "compose-lazy"
+version = "0.7.0"
+authors = [{ name = "Hiro Ito", email = "mobiiii24@gmail.com" }]
+keywords = ["docker", "docker compose", "alias", "command line tool", "productivity"]
+readme = "README.md"
+requires-python = ">=3.11"
+dynamic = ["description"]
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Topic :: Utilities",
+    "Environment :: Console",
+    "Operating System :: Microsoft :: Windows :: Windows 11",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14"
+]
+dependencies = [
+    "pyyaml>=6.0.3",
+]
+
+[project.scripts]
+dcp = "compose_lazy.main:main"
+dcpu = "compose_lazy.main:dcpu_main"
+dcpe = "compose_lazy.main:dcpe_main"
+
+[project.urls]
+Repository = "https://github.com/HiroItozzz/compose-lazy"
+Issues = "https://github.com/HiroItozzz/compose-lazy/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "pytest-cov>=7.1.0",
+    "python-dotenv>=1.2.2",
+    "ruff>=0.15.12",
+    "ty>=0.0.34",
+]
+
+[tool.flit.sdist]
+include = ["tests/"]
+
+[tool.uv]
+package = true
+
+[tool.ruff]
+line-length = 90
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.ty.src]
+include = ["src/"]

compose_lazy-0.7.0/src/compose_lazy/__init__.py

@@ -0,0 +1,10 @@
+"""A smart CLI wrapper for docker compose with interactive selection support."""
+
+import logging
+from importlib.metadata import version
+
+__version__ = version("compose-lazy")
+
+logger = logging.getLogger("compose_lazy")
+logger.addHandler(logging.NullHandler())
+logger.propagate = False

compose_lazy-0.7.0/src/compose_lazy/args.py

@@ -0,0 +1,155 @@
+import logging
+from argparse import ArgumentParser, Namespace
+from typing import Callable, Self
+
+from .process import DockerCmdProcessor
+
+logger = logging.getLogger(__name__)
+
+
+class ArgBuilder:
+    def __init__(self, parser: ArgumentParser):
+        self.parser = parser
+
+    def set_defaults(self, func: Callable[[Namespace], int] | None = None) -> Self:
+        func = func or DockerCmdProcessor()
+        self.parser.set_defaults(func=func)
+        return self
+
+    def add_common_compose_options(self) -> Self:
+        return self._add_file_args()._add_profile_args()._add_project_args()
+
+    def add_service_name_subcmd(self, multiple: bool = False) -> Self:
+        """Add positional argument of service name(s) to command definition.
+
+        multiple=True: accepts multiple service names, all optional (e.g. up, build, stop, etc.).
+        multiple=False: accepts single service name, required by docker compose (e.g. exec, run).
+        """
+        if multiple:
+            self.parser.add_argument(
+                "service_name",
+                nargs="*",
+                default=[],
+                help="(Optional) target service names",
+            )
+            # Add trigger option to start interactive selection explicitly.
+            self.parser.add_argument(
+                "-s",
+                "--service",
+                action="store_true",
+                help="show service name candidates, select interactively",
+            )
+        else:
+            # If no service_name given, interactive selection starts automatically.
+            self.parser.add_argument(
+                "service_name",
+                nargs="?",
+                type=lambda x: [x],
+                default=[],
+                help="(Required) target service name",
+            )
+        return self
+
+    def add_inner_bash_cmd_args(self) -> Self:
+        self.parser.add_argument(
+            "inner_bash_cmd",
+            nargs="*",
+            default=[],
+            help="command to run inside the service (default: bash)",
+        )
+        return self
+
+    def add_build_args(self) -> Self:
+        self.parser.add_argument(
+            "-b",
+            "--build",
+            action="store_true",
+            help="docker compose up `--build`",
+        )
+        return self
+
+    def add_detach_args(self) -> Self:
+        """add optional argument `-d` to `docker compose up` command."""
+        self.parser.add_argument(
+            "-d", "--detach", action="store_true", help="docker compose up `-d`"
+        )
+        return self
+
+    def add_follow_args(self) -> Self:
+        """add optional argument `-f` to `docker compose logs` command."""
+        self.parser.add_argument(
+            "-fo", "--follow", action="store_true", help="docker compose logs `-f`"
+        )
+        return self
+
+    def add_all_args(self) -> Self:
+        """add optional argument `--all(-a)` to `docker compose ps` command."""
+        self.parser.add_argument(
+            "-a",
+            "--all",
+            action="store_true",
+            help="docker compose ps `-a`",
+        )
+        return self
+
+    def add_status_args(self) -> Self:
+        self.parser.add_argument(
+            "-st",
+            "--status",
+            choices=[
+                "created",
+                "restarting",
+                "running",
+                "removing",
+                "paused",
+                "exited",
+                "dead",
+            ],
+            help="docker compose ps `--status` <STATUS>",
+        )
+        return self
+
+    def add_remove_orphans_args(self) -> Self:
+        self.parser.add_argument(
+            "-ro",
+            "--remove-orphans",
+            action="store_true",
+            help="docker compose down `--remove-orphans`",
+        )
+        return self
+
+    def add_wait_args(self) -> Self:
+        self.parser.add_argument(
+            "-w",
+            "--wait",
+            action="store_true",
+            help="docker compose up `--wait`",
+        )
+        return self
+
+    def _add_file_args(self) -> Self:
+        self.parser.add_argument(
+            "-f",
+            "--file",
+            nargs="*",
+            help="specify compose file(s). if omitted with -f, select interactively",
+        )
+        return self
+
+    def _add_project_args(self) -> Self:
+        self.parser.add_argument(
+            "-p",
+            "--project",
+            default="",
+            help="docker compose `-p PROJECT_NAME`",
+        )
+        return self
+
+    def _add_profile_args(self) -> Self:
+        self.parser.add_argument(
+            "-pf",
+            "--profile",
+            nargs="*",
+            help="specify profile(s). if omitted with -pf, select interactively",
+        )
+        return self