dxlabs 0.1.0__tar.gz

dxlabs-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*$py.class
+dist/
+build/
+*.egg-info/
+.venv/
+env/
+venv/
+.dxlabs.json
+.pytest_cache/
+.env
+**/__init__.py

dxlabs-0.1.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: dxlabs
+Version: 0.1.0
+Summary: A CLI tool by DX Labs to manage project assets, starting with .env on S3
+Author-email: DX Labs <contact@dxlabs.io>
+Requires-Python: >=3.9
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: pydantic-settings>=2.2.0
+Requires-Dist: rich>=13.7.0
+Description-Content-Type: text/markdown
+
+# dxlabs
+
+A Python CLI tool by DX Labs to manage project assets. Currently supporting `.env` file management on AWS S3.
+
+## Installation
+
+```bash
+pip install dxlabs
+```
+
+## Usage
+
+### Initialize configuration
+
+```bash
+dxlabs init --bucket my-env-bucket --project my-project-name --profile my-aws-profile
+```
+
+### Push local .env to S3
+
+```bash
+dxlabs env push --env development
+```
+
+### Pull from S3 to local .env
+
+```bash
+dxlabs env pull --env staging
+```
+
+## Features
+
+- **Multi-Environment Support**: Specify environments like `dev`, `staging`, `prod`.
+- **S3 Backend**: Secure storage in your own AWS S3 bucket.
+- **CI/CD Integration**: Supports AWS environment variables for credentials.

dxlabs-0.1.0/README.md

@@ -0,0 +1,35 @@
+# dxlabs
+
+A Python CLI tool by DX Labs to manage project assets. Currently supporting `.env` file management on AWS S3.
+
+## Installation
+
+```bash
+pip install dxlabs
+```
+
+## Usage
+
+### Initialize configuration
+
+```bash
+dxlabs init --bucket my-env-bucket --project my-project-name --profile my-aws-profile
+```
+
+### Push local .env to S3
+
+```bash
+dxlabs env push --env development
+```
+
+### Pull from S3 to local .env
+
+```bash
+dxlabs env pull --env staging
+```
+
+## Features
+
+- **Multi-Environment Support**: Specify environments like `dev`, `staging`, `prod`.
+- **S3 Backend**: Secure storage in your own AWS S3 bucket.
+- **CI/CD Integration**: Supports AWS environment variables for credentials.

dxlabs-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "dxlabs"
+version = "0.1.0"
+description = "A CLI tool by DX Labs to manage project assets, starting with .env on S3"
+authors = [
+    { name = "DX Labs", email = "contact@dxlabs.io" }
+]
+dependencies = [
+    "boto3>=1.34.0",
+    "click>=8.1.0",
+    "rich>=13.7.0",
+    "pydantic-settings>=2.2.0"
+]
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.scripts]
+dxlabs = "dxlabs.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dxlabs"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

dxlabs-0.1.0/src/dxlabs/cli.py

@@ -0,0 +1,143 @@
+"""
+CLI entry point for dxlabs.
+Defines the command structure and handles user interaction for asset management.
+"""
+
+import os
+
+import click
+from rich.console import Console
+from rich.panel import Panel
+
+from .config import load_config, save_config
+from .core.env_manager import EnvManager
+
+console = Console()
+
+
+@click.group()
+def main():
+    """
+    dxlabs: DX Labs CLI for project asset management.
+    A tool to manage environment files and other project resources efficiently.
+    """
+    pass
+
+
+@main.command()
+@click.option(
+    "--bucket", required=True, help="The AWS S3 bucket name to use for storage."
+)
+@click.option(
+    "--project", required=True, help="A unique project name (used as a key prefix)."
+)
+@click.option(
+    "--region",
+    default="ap-northeast-1",
+    help="The AWS region to use. Defaults to ap-northeast-1.",
+)
+@click.option(
+    "--profile", default=None, help="The AWS profile name to use for credentials."
+)
+def init(bucket, project, region, profile):
+    """
+    Initialize dxlabs configuration for the current project.
+    Saves settings to a local .dxlabs.json file.
+    """
+    save_config(bucket, project, region, profile)
+    profile_display = profile if profile else "default/env-var"
+    console.print(
+        Panel(
+            f"Configuration saved to [bold cyan].dxlabs.json[/bold cyan]\n"
+            f"Bucket: [green]{bucket}[/green]\n"
+            f"Project: [green]{project}[/green]\n"
+            f"Region: [green]{region}[/green]\n"
+            f"Profile: [green]{profile_display}[/green]",
+            title="Success",
+        )
+    )
+
+
+@main.group()
+def env():
+    """
+    Manage project environment (.env) files.
+    Sub-commands for pushing to and pulling from the cloud.
+    """
+    pass
+
+
+@env.command(name="push")
+@click.option(
+    "--env",
+    "env_name",
+    default="development",
+    help="The environment name (e.g., 'dev', 'prod').",
+)
+@click.option(
+    "--file",
+    default=".env",
+    help="Path to the local file to upload. Defaults to '.env'.",
+)
+def env_push(env_name, file):
+    """
+    Upload a local .env file to S3.
+    """
+    config = load_config()
+    if not config:
+        console.print(
+            "[red]Error: Project not initialized. Run 'dxlabs init' first.[/red]"
+        )
+        return
+
+    if not os.path.exists(file):
+        console.print(f"[red]Error: Local file '{file}' not found.[/red]")
+        return
+
+    manager = EnvManager(config)
+    remote_key = manager.get_remote_key(env_name)
+
+    console.print(
+        f"Uploading [cyan]{file}[/cyan] to [bold]s3://{config.bucket}/{remote_key}[/bold]..."
+    )
+    if manager.push(file, env_name):
+        console.print("[bold green]Successfully uploaded![/bold green]")
+    else:
+        console.print("[bold red]Upload failed.[/bold red]")
+
+
+@env.command(name="pull")
+@click.option(
+    "--env",
+    "env_name",
+    default="development",
+    help="The environment name to download from.",
+)
+@click.option(
+    "--file", default=".env", help="The local destination path. Defaults to '.env'."
+)
+def env_pull(env_name, file):
+    """
+    Download a .env file from S3 to the local filesystem.
+    """
+    config = load_config()
+    if not config:
+        console.print(
+            "[red]Error: Project not initialized. Run 'dxlabs init' first.[/red]"
+        )
+        return
+
+    manager = EnvManager(config)
+    remote_key = manager.get_remote_key(env_name)
+
+    console.print(
+        f"Downloading from [bold]s3://{config.bucket}/{remote_key}[/bold] to [cyan]{file}[/cyan]..."
+    )
+    if manager.pull(env_name, file):
+        console.print("[bold green]Successfully downloaded![/bold green]")
+    else:
+        console.print("[bold red]Download failed.[/bold red]")
+
+
+if __name__ == "__main__":
+    main()

dxlabs-0.1.0/src/dxlabs/config.py

@@ -0,0 +1,67 @@
+"""
+Configuration management for the dxlabs CLI.
+Handles loading and saving of the .dxlabs.json configuration file.
+"""
+
+import json
+from pathlib import Path
+from typing import Optional
+
+from pydantic import BaseModel
+
+CONFIG_FILE = ".dxlabs.json"
+
+
+class Config(BaseModel):
+    """
+    Configuration model for dxlabs project settings.
+
+    Attributes:
+        bucket (str): The AWS S3 bucket name.
+        project (str): The unique project identifier used as a prefix in S3.
+        region (str): The AWS region for S3 operations.
+        profile (Optional[str]): The AWS profile name to use for credentials.
+    """
+
+    bucket: str
+    project: str
+    region: Optional[str] = "ap-northeast-1"
+    profile: Optional[str] = None
+
+
+def load_config() -> Optional[Config]:
+    """
+    Loads the project configuration from the local .dxlabs.json file.
+
+    Returns:
+        Optional[Config]: The configuration object if found and valid, else None.
+    """
+    config_path = Path(CONFIG_FILE)
+    if not config_path.exists():
+        return None
+    try:
+        with open(config_path, "r") as f:
+            data = json.load(f)
+            return Config(**data)
+    except Exception:
+        return None
+
+
+def save_config(
+    bucket: str,
+    project: str,
+    region: str = "ap-northeast-1",
+    profile: Optional[str] = None,
+):
+    """
+    Saves the project configuration to a local .dxlabs.json file.
+
+    Args:
+        bucket (str): The S3 bucket name to use.
+        project (str): The project name/prefix for storage.
+        region (str): The AWS region (defaults to ap-northeast-1).
+        profile (Optional[str]): The AWS profile name to use.
+    """
+    config = Config(bucket=bucket, project=project, region=region, profile=profile)
+    with open(CONFIG_FILE, "w") as f:
+        json.dump(config.model_dump(), f, indent=4)

dxlabs-0.1.0/src/dxlabs/core/env_manager.py

@@ -0,0 +1,72 @@
+"""
+Core environment management logic for dxlabs.
+Handles the high-level business logic for pushing and pulling .env files.
+"""
+
+from ..config import Config
+from ..providers.s3 import S3Provider
+
+
+class EnvManager:
+    """
+    Manager for project environment (.env) files.
+    Coordinates between the configuration and the storage provider.
+
+    Attributes:
+        config (Config): The project configuration.
+        provider (S3Provider): The storage provider (currently S3).
+    """
+
+    def __init__(self, config: Config):
+        """
+        Initializes the EnvManager with a project configuration.
+
+        Args:
+            config (Config): The project settings (bucket, project ID, region, profile).
+        """
+        self.config = config
+        self.provider = S3Provider(
+            bucket=config.bucket, region=config.region, profile=config.profile
+        )
+
+    def get_remote_key(self, env_name: str) -> str:
+        """
+        Constructs the standard S3 key for an environment file.
+
+        Format: {project_id}/{environment_name}/.env
+
+        Args:
+            env_name (str): The name of the environment (e.g., 'staging', 'dev').
+
+        Returns:
+            str: The fully qualified remote path/key.
+        """
+        return f"{self.config.project}/{env_name}/.env"
+
+    def push(self, local_path: str, env_name: str) -> bool:
+        """
+        Pushes a local file to the remote storage for a given environment.
+
+        Args:
+            local_path (str): Path to the local file to upload.
+            env_name (str): The environment name to target in the cloud.
+
+        Returns:
+            bool: True if the operation succeeded, False otherwise.
+        """
+        remote_key = self.get_remote_key(env_name)
+        return self.provider.upload(local_path, remote_key)
+
+    def pull(self, env_name: str, local_path: str) -> bool:
+        """
+        Pulls a file from remote storage to a local path for a given environment.
+
+        Args:
+            env_name (str): The environment name to pull from.
+            local_path (str): The local destination where the file should be saved.
+
+        Returns:
+            bool: True if the operation succeeded, False otherwise.
+        """
+        remote_key = self.get_remote_key(env_name)
+        return self.provider.download(remote_key, local_path)

dxlabs-0.1.0/src/dxlabs/providers/s3.py

@@ -0,0 +1,68 @@
+"""
+AWS S3 storage provider implementation.
+Handles low-level operations with AWS S3 using boto3.
+"""
+
+from typing import Optional
+
+import boto3
+from botocore.exceptions import ClientError
+
+
+class S3Provider:
+    """
+    Provider class for interacting with AWS S3.
+
+    Attributes:
+        bucket (str): The name of the S3 bucket.
+        s3 (boto3.client): The initialized boto3 S3 client.
+    """
+
+    def __init__(self, bucket: str, region: Optional[str] = "ap-northeast-1", profile: Optional[str] = None):
+        """
+        Initializes the S3 client.
+
+        Args:
+            bucket (str): The name of the S3 bucket to use.
+            region (str, optional): The AWS region. Defaults to "ap-northeast-1".
+            profile (str, optional): The AWS profile name to use.
+        """
+        self.bucket = bucket
+        # Use session to support profile-based credentials
+        session = boto3.Session(profile_name=profile)
+        self.s3 = session.client("s3", region_name=region)
+
+    def upload(self, local_path: str, remote_key: str) -> bool:
+        """
+        Uploads a local file to a specific key in S3.
+
+        Args:
+            local_path (str): The path to the file on the local filesystem.
+            remote_key (str): The key (path) where the file will be stored in S3.
+
+        Returns:
+            bool: True if the upload was successful, False otherwise.
+        """
+        try:
+            self.s3.upload_file(local_path, self.bucket, remote_key)
+            return True
+        except ClientError:
+            # Error details can be logged here if needed
+            return False
+
+    def download(self, remote_key: str, local_path: str) -> bool:
+        """
+        Downloads a file from S3 to the local filesystem.
+
+        Args:
+            remote_key (str): The key of the file to download from S3.
+            local_path (str): The local path where the file should be saved.
+
+        Returns:
+            bool: True if the download was successful, False otherwise.
+        """
+        try:
+            self.s3.download_file(self.bucket, remote_key, local_path)
+            return True
+        except ClientError:
+            return False