devservices 0.0.2__tar.gz → 0.0.3__tar.gz

{devservices-0.0.2 → devservices-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 0.0.2
+Version: 0.0.3
 Requires-Python: >=3.10
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv

devservices-0.0.3/README.md

@@ -0,0 +1,22 @@
+# devservices
+
+A standalone cli tool used to manage dependencies for services. It simplifies the process of starting, stopping, and managing services for development purposes.
+
+## Overview
+
+`devservices` reads configuration files located in the `devservices` directory of your repository. These configurations define services, their dependencies, and various modes of operation.
+
+## Usage
+
+devservices provides several commands to manage your services:
+
+### Commands
+
+NOTE: service-name is an optional parameter. If not provided, devservices will attempt to automatically find a devservices configuration in the current directory in order to proceed.
+
+- `devservices start <service-name>`: Start a service and its dependencies.
+- `devservices stop <service-name>`: Stop a service including its dependencies.
+- `devservices status <service-name>`: Display the current status of all services, including their dependencies and ports.
+- `devservices logs <service-name>`: View logs for a specific service.
+- `devservices list-services`: List all available Sentry services.
+- `devservices list-dependencies <service-name>`: List all dependencies for a service and whether they are enabled/disabled.

{devservices-0.0.2 → devservices-0.0.3}/devservices/commands/logs.py

@@ -6,8 +6,8 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from devservices.exceptions import DockerComposeError
 from devservices.utils.docker_compose import run_docker_compose_command
 from devservices.utils.services import find_matching_service
@@ -37,7 +37,7 @@ def logs(args: Namespace) -> None:
     mode_to_use = "default"
     mode_dependencies = " ".join(modes[mode_to_use])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     try:
         logs = run_docker_compose_command(

{devservices-0.0.2 → devservices-0.0.3}/devservices/commands/start.py

@@ -5,8 +5,8 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from devservices.exceptions import DockerComposeError
 from devservices.utils.console import Status
 from devservices.utils.docker_compose import run_docker_compose_command
@@ -34,7 +34,7 @@ def start(args: Namespace) -> None:
     mode_to_start = "default"
     mode_dependencies = " ".join(modes[mode_to_start])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     with Status(f"Starting {service.name}", f"{service.name} started") as status:
         try:

{devservices-0.0.2 → devservices-0.0.3}/devservices/commands/status.py

@@ -7,8 +7,8 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from devservices.exceptions import DockerComposeError
 from devservices.utils.docker_compose import run_docker_compose_command
 from devservices.utils.services import find_matching_service
@@ -49,7 +49,7 @@ def format_status_output(status_json: str) -> str:
             output.append("Ports:")
             for port in ports:
                 output.append(
-                    f"  {port['PublishedPort']} -> {port['TargetPort']}/{port['Protocol']}"
+                    f"  {port['URL']}:{port['PublishedPort']} -> {port['TargetPort']}/{port['Protocol']}"
                 )
         else:
             output.append("No ports exposed")
@@ -72,7 +72,7 @@ def status(args: Namespace) -> None:
     mode_to_view = "default"
     mode_dependencies = " ".join(modes[mode_to_view])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     try:
         status_json = run_docker_compose_command(

{devservices-0.0.2 → devservices-0.0.3}/devservices/commands/stop.py

@@ -5,8 +5,8 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from devservices.exceptions import DockerComposeError
 from devservices.utils.console import Status
 from devservices.utils.docker_compose import run_docker_compose_command
@@ -34,7 +34,7 @@ def stop(args: Namespace) -> None:
     mode_to_stop = "default"
     mode_dependencies = " ".join(modes[mode_to_stop])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     with Status(f"Stopping {service.name}", f"{service.name} stopped") as status:
         try:

{devservices-0.0.2 → devservices-0.0.3}/devservices/configs/service_config.py

@@ -5,8 +5,8 @@ from dataclasses import dataclass
 
 import yaml
 
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from devservices.exceptions import ConfigNotFoundError
 from devservices.exceptions import ConfigParseError
 from devservices.exceptions import ConfigValidationError
@@ -14,10 +14,17 @@ from devservices.exceptions import ConfigValidationError
 VALID_VERSIONS = [0.1]
 
 
+@dataclass
+class RemoteConfig:
+    repo_name: str
+    branch: str
+    repo_link: str
+
+
 @dataclass
 class Dependency:
     description: str
-    link: str | None = None
+    remote: RemoteConfig | None = None
 
 
 @dataclass
@@ -56,9 +63,7 @@ class ServiceConfig:
 
 
 def load_service_config_from_file(repo_path: str) -> ServiceConfig:
-    config_path = os.path.join(
-        repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
-    )
+    config_path = os.path.join(repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME)
     if not os.path.exists(config_path):
         raise ConfigNotFoundError(f"Config file not found in directory: {config_path}")
     with open(config_path, "r") as stream:

{devservices-0.0.2 → devservices-0.0.3}/devservices/constants.py

@@ -1,4 +1,4 @@
 from __future__ import annotations
 
 DEVSERVICES_DIR_NAME = "devservices"
-DOCKER_COMPOSE_FILE_NAME = "docker-compose.yml"
+CONFIG_FILE_NAME = "config.yml"

{devservices-0.0.2 → devservices-0.0.3}/devservices/main.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import argparse
 import atexit
+from importlib import metadata
 
 import sentry_sdk
 from sentry_sdk.integrations.argv import ArgvIntegration
@@ -29,11 +30,15 @@ def cleanup() -> None:
 
 def main() -> None:
     parser = argparse.ArgumentParser(
-        description="DevServices CLI tool for managing Docker Compose services."
+        prog="devservices",
+        description="CLI tool for managing service dependencies.",
+        usage="devservices [-h] [--version] COMMAND ...",
+    )
+    parser.add_argument(
+        "--version", action="version", version=metadata.version("devservices")
     )
-    parser.add_argument("--version", action="version", version="%(prog)s 0.0.1")
 
-    subparsers = parser.add_subparsers(dest="command", help="Available commands")
+    subparsers = parser.add_subparsers(dest="command", title="commands", metavar="")
 
     # Add subparsers for each command
     start.add_parser(subparsers)

{devservices-0.0.2 → devservices-0.0.3}/devservices.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 0.0.2
+Version: 0.0.3
 Requires-Python: >=3.10
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv

{devservices-0.0.2 → devservices-0.0.3}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=45", "wheel"]
+requires = ["setuptools>=70", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "devservices"
-version = "0.0.2"
+version = "0.0.3"
 # 3.10 is just for internal pypi compat
 requires-python = ">=3.10"
 dependencies = [

{devservices-0.0.2 → devservices-0.0.3}/tests/commands/test_start.py

@@ -9,8 +9,8 @@ from unittest import mock
 import pytest
 
 from devservices.commands.start import start
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from tests.testutils import create_config_file
 
 
@@ -44,7 +44,7 @@ def test_start_simple(mock_run: mock.Mock, tmp_path: Path) -> None:
             "docker",
             "compose",
             "-f",
-            f"{tmp_path}/{DEVSERVICES_DIR_NAME}/{DOCKER_COMPOSE_FILE_NAME}",
+            f"{tmp_path}/{DEVSERVICES_DIR_NAME}/{CONFIG_FILE_NAME}",
             "up",
             "-d",
             "redis",

{devservices-0.0.2 → devservices-0.0.3}/tests/commands/test_stop.py

@@ -9,8 +9,8 @@ from unittest import mock
 import pytest
 
 from devservices.commands.stop import stop
+from devservices.constants import CONFIG_FILE_NAME
 from devservices.constants import DEVSERVICES_DIR_NAME
-from devservices.constants import DOCKER_COMPOSE_FILE_NAME
 from tests.testutils import create_config_file
 
 
@@ -45,7 +45,7 @@ def test_stop_simple(mock_run: mock.Mock, tmp_path: Path) -> None:
             "docker",
             "compose",
             "-f",
-            f"{tmp_path}/{DEVSERVICES_DIR_NAME}/{DOCKER_COMPOSE_FILE_NAME}",
+            f"{tmp_path}/{DEVSERVICES_DIR_NAME}/{CONFIG_FILE_NAME}",
             "down",
             "redis",
             "clickhouse",

{devservices-0.0.2 → devservices-0.0.3}/tests/configs/test_service_config.py

@@ -25,7 +25,11 @@ from tests.testutils import create_config_file
             {
                 "example-dependency-1": {
                     "description": "Example dependency 1",
-                    "link": "https://example.com",
+                    "remote": {
+                        "repo_name": "example-dependency-1",
+                        "branch": "main",
+                        "repo_link": "https://example.com",
+                    },
                 },
                 "example-dependency-2": {
                     "description": "Example dependency 2",
@@ -38,7 +42,11 @@ from tests.testutils import create_config_file
             {
                 "example-dependency-1": {
                     "description": "Example dependency 1",
-                    "link": "https://example.com",
+                    "remote": {
+                        "repo_name": "example-dependency-1",
+                        "branch": "main",
+                        "repo_link": "https://example.com",
+                    },
                 },
                 "example-dependency-2": {
                     "description": "Example dependency 2",
@@ -69,7 +77,10 @@ def test_load_service_config_from_file(
         "version": 0.1,
         "service_name": service_name,
         "dependencies": {
-            key: {"description": value["description"], "link": value.get("link")}
+            key: {
+                "description": value["description"],
+                "remote": value.get("remote"),
+            }
             for key, value in dependencies.items()
         },
         "modes": modes,
@@ -100,7 +111,7 @@ def test_load_service_config_from_file_missing_config(tmp_path: Path) -> None:
         load_service_config_from_file(str(tmp_path))
     assert (
         str(e.value)
-        == f"Config file not found in directory: {tmp_path / 'devservices' / 'docker-compose.yml'}"
+        == f"Config file not found in directory: {tmp_path / 'devservices' / 'config.yml'}"
     )
 
 
@@ -287,7 +298,7 @@ def test_load_service_config_from_file_invalid_yaml(tmp_path: Path) -> None:
         default: ["example-dependency"]"""
     devservices_dir = Path(tmp_path, "devservices")
     devservices_dir.mkdir(parents=True, exist_ok=True)
-    tmp_file = Path(devservices_dir, "docker-compose.yml")
+    tmp_file = Path(devservices_dir, "config.yml")
     with tmp_file.open("w") as f:
         f.write(config)
 
@@ -295,7 +306,7 @@ def test_load_service_config_from_file_invalid_yaml(tmp_path: Path) -> None:
         load_service_config_from_file(str(tmp_path))
     assert (
         str(e.value)
-        == f"Error parsing config file: mapping values are not allowed here\n  in \"{tmp_path / 'devservices' / 'docker-compose.yml'}\", line 2, column 12"
+        == f"Error parsing config file: mapping values are not allowed here\n  in \"{tmp_path / 'devservices' / 'config.yml'}\", line 2, column 12"
     )
 
 
@@ -311,7 +322,7 @@ def test_load_service_config_from_file_invalid_yaml_tag(tmp_path: Path) -> None:
         default: ["example-dependency"]"""
     devservices_dir = Path(tmp_path, "devservices")
     devservices_dir.mkdir(parents=True, exist_ok=True)
-    tmp_file = Path(devservices_dir, "docker-compose.yml")
+    tmp_file = Path(devservices_dir, "config.yml")
     with tmp_file.open("w") as f:
         f.write(config)
 
@@ -319,5 +330,5 @@ def test_load_service_config_from_file_invalid_yaml_tag(tmp_path: Path) -> None:
         load_service_config_from_file(str(tmp_path))
     assert (
         str(e.value)
-        == f"Error parsing config file: could not determine a constructor for the tag 'tag:yaml.org,2002:invalid_tag'\n  in \"{tmp_path / 'devservices' / 'docker-compose.yml'}\", line 7, column 19"
+        == f"Error parsing config file: could not determine a constructor for the tag 'tag:yaml.org,2002:invalid_tag'\n  in \"{tmp_path / 'devservices' / 'config.yml'}\", line 7, column 19"
     )

{devservices-0.0.2 → devservices-0.0.3}/tests/testutils.py

@@ -10,6 +10,6 @@ def create_config_file(
 ) -> None:
     devservices_dir = Path(tmp_path, "devservices")
     devservices_dir.mkdir(parents=True, exist_ok=True)
-    tmp_file = Path(devservices_dir, "docker-compose.yml")
+    tmp_file = Path(devservices_dir, "config.yml")
     with tmp_file.open("w") as f:
         yaml.dump(config, f, sort_keys=False, default_flow_style=False)

devservices-0.0.2/README.md

@@ -1 +0,0 @@
-# devservices