Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ Deploy Airflow DAGs, Jupyter notebooks, and ML workflows from development to pro

## Quick Start

**Install from source:**
**Install:**
```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

**Deploy your first application:**
Expand Down Expand Up @@ -1151,16 +1149,16 @@ genai_dev_workflow:

## Security Notice

⚠️ **DO NOT** install from PyPI - always install from official AWS source code.
Always install from the official AWS PyPI package or source code.

```bash
# ✅ Correct - Install from official AWS repository
# ✅ Correct - Install from official AWS PyPI package
pip install aws-smus-cicd-cli

# ✅ Also correct - Install from official AWS source code
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .

# ❌ Wrong - Do not use PyPI
pip install aws-smus-cicd-cli # May contain malicious code
```

---
Expand Down
14 changes: 3 additions & 11 deletions docs/getting-started/admin-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ As an admin, you'll configure:
## Step 1: Install the CLI

```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

---
Expand Down Expand Up @@ -404,10 +402,7 @@ jobs:
python-version: '3.9'

- name: Install SMUS CI/CD CLI
run: |
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
run: pip install aws-smus-cicd-cli

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v2
Expand Down Expand Up @@ -443,10 +438,7 @@ jobs:
- uses: actions/checkout@v3

- name: Install SMUS CI/CD CLI
run: |
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
run: pip install aws-smus-cicd-cli

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v2
Expand Down
10 changes: 7 additions & 3 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,14 @@

## Step 1: Install the CLI

```bash
pip install aws-smus-cicd-cli
```

To use the bundled examples, also clone the repository:

```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
```

---
Expand All @@ -33,7 +37,7 @@ pip install -e .
Copy the data notebooks example:

```bash
cp -r examples/analytic-workflow/data-notebooks my-notebook-app
cp -r CICD-for-SageMakerUnifiedStudio/examples/analytic-workflow/data-notebooks my-notebook-app
cd my-notebook-app
```

Expand Down
8 changes: 2 additions & 6 deletions docs/langs/fr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@

**Installation depuis les sources :**
```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

**Déployez votre première application :**
Expand Down Expand Up @@ -284,9 +282,7 @@ Déployez des notebooks Jupyter avec orchestration d'exécution parallèle pour

```bash
# ✅ Correct - Install from official AWS repository
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli

# ❌ Wrong - Do not use PyPI
pip install aws-smus-cicd-cli # May contain malicious code
Expand Down
8 changes: 2 additions & 6 deletions docs/langs/he/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,7 @@
<div dir="ltr">

```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

</div>
Expand Down Expand Up @@ -418,9 +416,7 @@ Both modes work with any combination of storage and git content sources.

```bash
# ✅ נכון - התקנה ממאגר AWS הרשמי
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli

# ❌ לא נכון - אין להשתמש ב-PyPI
pip install aws-smus-cicd-cli # עלול להכיל קוד זדוני
Expand Down
8 changes: 2 additions & 6 deletions docs/langs/it/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@

**Installazione dai sorgenti:**
```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

**Distribuisci la tua prima applicazione:**
Expand Down Expand Up @@ -320,9 +318,7 @@ dashboard-glue-quick/

```bash
# ✅ Corretto - Installare dal repository ufficiale AWS
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli

# ❌ Sbagliato - Non usare PyPI
pip install aws-smus-cicd-cli # Potrebbe contenere codice malevolo
Expand Down
8 changes: 2 additions & 6 deletions docs/langs/ja/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@

**ソースからインストール:**
```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

**最初のアプリケーションをデプロイ:**
Expand Down Expand Up @@ -417,9 +415,7 @@ data-notebooks/

```bash
# ✅ 正しい方法 - AWSの公式リポジトリからインストール
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli

# ❌ 誤った方法 - PyPIを使用しないでください
pip install aws-smus-cicd-cli # 悪意のあるコードが含まれている可能性があります
Expand Down
8 changes: 2 additions & 6 deletions docs/langs/pt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ Implante DAGs do Airflow, notebooks Jupyter e workflows de ML do desenvolvimento

**Instalar do código fonte:**
```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

**Implante sua primeira aplicação:**
Expand Down Expand Up @@ -835,9 +833,7 @@ stages:

```bash
# ✅ Correto - Instalar do repositório oficial da AWS
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli

# ❌ Errado - Não use PyPI
pip install aws-smus-cicd-cli # Pode conter código malicioso
Expand Down
8 changes: 2 additions & 6 deletions docs/langs/zh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@

**从源代码安装:**
```bash
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli
```

**部署你的第一个应用:**
Expand Down Expand Up @@ -431,9 +429,7 @@ data-notebooks/

```bash
# ✅ 正确 - 从 AWS 官方仓库安装
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
pip install aws-smus-cicd-cli

# ❌ 错误 - 不要使用 PyPI
pip install aws-smus-cicd-cli # 可能包含恶意代码
Expand Down
8 changes: 5 additions & 3 deletions docs/pypi-publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,13 @@ The GitHub workflow will automatically:
Once published, users can install with:

## ⚠️ Security Notice
**DO NOT** install `aws-smus-cicd-cli` from PyPI as it may contain malicious code.
The package name has been compromised. Always install from source:
Always install `aws-smus-cicd-cli` from the official AWS PyPI package or source code.

```bash
# Clone the official AWS repository
# Install from PyPI
pip install aws-smus-cicd-cli

# Or install from source
git clone https://github.com/aws/CICD-for-SageMakerUnifiedStudio.git
cd CICD-for-SageMakerUnifiedStudio
pip install -e .
Expand Down
1 change: 0 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[metadata]
name = aws-smus-cicd-cli
version = 1.0
description = SMUS CI/CD Pipeline CLI
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@

setup(
name="aws-smus-cicd-cli",
version="1.0.0",
author="AWS SageMaker Unified Studio Team",
author_email="sagemaker-unified-studio@amazon.com",
description="A CLI tool for managing CI/CD pipelines in SageMaker Unified Studio (SMUS)",
Expand Down
7 changes: 6 additions & 1 deletion src/smus_cicd/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""SMUS CI/CD CLI package."""

__version__ = "0.1.1"
from importlib.metadata import PackageNotFoundError, version

try:
__version__ = version("aws-smus-cicd-cli")
except PackageNotFoundError:
__version__ = "unknown"
22 changes: 22 additions & 0 deletions src/smus_cicd/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ def show_help_suggestion():
LOG_LEVEL = None


def _version_callback(value: bool):
if value:
console.print(f"aws-smus-cicd-cli {__version__}")
raise typer.Exit()


@app.callback()
def main(
ctx: typer.Context,
Expand All @@ -88,12 +94,28 @@ def main(
help="Set logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
case_sensitive=False,
),
show_version: bool = typer.Option(
None,
"--version",
"-v",
help="Show the CLI version and exit.",
is_eager=True,
callback=_version_callback,
),
):
"""SMUS CI/CD CLI - Manage SageMaker Unified Studio CI/CD pipelines."""
global LOG_LEVEL
LOG_LEVEL = log_level


@app.command(
"version", help="Show the CLI version.", rich_help_panel="Pipeline Commands"
)
def version():
"""Show the installed version of aws-smus-cicd-cli."""
console.print(f"aws-smus-cicd-cli {__version__}")


# Register commands with proper ordering
@app.command(
"describe",
Expand Down
Loading