datacommons-cli 0.0.2__tar.gz → 1.0.0__tar.gz

datacommons_cli-1.0.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: datacommons-cli
+Version: 1.0.0
+Summary: Data Commons CLI
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1.7
+Requires-Dist: datacommons-admin
+
+# Data Commons CLI
+
+<p align="center">
+  <a href="https://www.datacommons.org"><img src="https://datacommons.org/images/dc-logo.svg" alt="Data Commons" width="120"></a>
+</p>
+
+<p align="center">
+  <em>Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.</em>
+</p>
+
+---
+
+[Data Commons](https://www.datacommons.org) is an open-source project initiated by Google that aggregates data from hundreds of public sources, such as the US Census, Eurostat, CDC, and UN, into a unified, standard Knowledge Graph.
+
+The **Data Commons Platform** provides the infrastructure to run your own private instance of Data Commons, allowing you to seamlessly combine public datasets with your own custom, private data using modern APIs, graph query engines, and visualization dashboards.
+
+---
+
+## Installation
+
+Install the Data Commons CLI using `pip` or `uv`:
+
+### Install with `pip`
+
+```bash
+pip install --user datacommons-cli
+```
+
+If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:
+
+```
+export PATH="$PATH:$(python3 -m site --user-base)/bin"
+```
+
+### Install with `uv`
+
+```bash
+uv tool install datacommons-cli
+```
+
+If the `datacommons` command is not found after installing, add the appropriate directory to your PATH:
+
+```
+export PATH="~/.local/bin:$PATH"
+```
+
+### With `uvx`
+
+Or execute `datacommons-cli` on-the-fly without installation using `uvx`:
+
+```bash
+uvx datacommons-cli --help
+```
+
+## Help & Documentation
+
+For full documentation, tutorials, and deployment guides, visit:
+👉 **[docs.datacommons.org](https://docs.datacommons.org)**
+
+---
+
+## Usage
+
+The CLI exposes standard operations under the main `datacommons` entrypoint. You can check the version and get help instantly:
+
+```bash
+# Show help menu
+datacommons --help
+
+# Show version
+datacommons --version
+```
+
+---
+
+## Administrative Commands
+
+All infrastructure setup, database operations, and ingestion pipelines are managed under the `admin` sub-command group:
+
+```bash
+datacommons admin [COMMAND] --help
+```
+
+### Available Commands
+
+| Command | Description |
+| --- | --- |
+| **`init`** | Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP). |
+| **`init-db`** | Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service. |
+| **`seed-db`** | Re-runs or updates base geographic and schema seeds on GCP Spanner. |
+| **`ingest start`** | Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets. |
+| **`ingest show-config`**| Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials. |
+
+### Quickstart: Scaffolding a Private Data Commons
+
+1. Initialize your project configuration and scaffold Terraform templates:
+   ```bash
+   datacommons admin init --project-id my-gcp-project --namespace prod
+   ```
+
+2. Change directories to the scaffolded directory (e.g. `cd prod`).
+
+3. Initialize and deploy your GCP infrastructure with Terraform:
+   ```bash
+   terraform init
+   terraform apply
+   ```
+
+4. Initialize and seed your Spanner database:
+   ```bash
+   datacommons admin init-db
+   ```
+
+5. Trigger the data ingestion pipeline:
+   ```bash
+   datacommons admin ingest start
+   ```
+
+---
+
+License: [Apache-2.0](https://github.com/datacommonsorg/datacommons/blob/main/LICENSE)

datacommons_cli-1.0.0/README.md

@@ -0,0 +1,121 @@
+# Data Commons CLI
+
+<p align="center">
+  <a href="https://www.datacommons.org"><img src="https://datacommons.org/images/dc-logo.svg" alt="Data Commons" width="120"></a>
+</p>
+
+<p align="center">
+  <em>Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.</em>
+</p>
+
+---
+
+[Data Commons](https://www.datacommons.org) is an open-source project initiated by Google that aggregates data from hundreds of public sources, such as the US Census, Eurostat, CDC, and UN, into a unified, standard Knowledge Graph.
+
+The **Data Commons Platform** provides the infrastructure to run your own private instance of Data Commons, allowing you to seamlessly combine public datasets with your own custom, private data using modern APIs, graph query engines, and visualization dashboards.
+
+---
+
+## Installation
+
+Install the Data Commons CLI using `pip` or `uv`:
+
+### Install with `pip`
+
+```bash
+pip install --user datacommons-cli
+```
+
+If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:
+
+```
+export PATH="$PATH:$(python3 -m site --user-base)/bin"
+```
+
+### Install with `uv`
+
+```bash
+uv tool install datacommons-cli
+```
+
+If the `datacommons` command is not found after installing, add the appropriate directory to your PATH:
+
+```
+export PATH="~/.local/bin:$PATH"
+```
+
+### With `uvx`
+
+Or execute `datacommons-cli` on-the-fly without installation using `uvx`:
+
+```bash
+uvx datacommons-cli --help
+```
+
+## Help & Documentation
+
+For full documentation, tutorials, and deployment guides, visit:
+👉 **[docs.datacommons.org](https://docs.datacommons.org)**
+
+---
+
+## Usage
+
+The CLI exposes standard operations under the main `datacommons` entrypoint. You can check the version and get help instantly:
+
+```bash
+# Show help menu
+datacommons --help
+
+# Show version
+datacommons --version
+```
+
+---
+
+## Administrative Commands
+
+All infrastructure setup, database operations, and ingestion pipelines are managed under the `admin` sub-command group:
+
+```bash
+datacommons admin [COMMAND] --help
+```
+
+### Available Commands
+
+| Command | Description |
+| --- | --- |
+| **`init`** | Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP). |
+| **`init-db`** | Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service. |
+| **`seed-db`** | Re-runs or updates base geographic and schema seeds on GCP Spanner. |
+| **`ingest start`** | Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets. |
+| **`ingest show-config`**| Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials. |
+
+### Quickstart: Scaffolding a Private Data Commons
+
+1. Initialize your project configuration and scaffold Terraform templates:
+   ```bash
+   datacommons admin init --project-id my-gcp-project --namespace prod
+   ```
+
+2. Change directories to the scaffolded directory (e.g. `cd prod`).
+
+3. Initialize and deploy your GCP infrastructure with Terraform:
+   ```bash
+   terraform init
+   terraform apply
+   ```
+
+4. Initialize and seed your Spanner database:
+   ```bash
+   datacommons admin init-db
+   ```
+
+5. Trigger the data ingestion pipeline:
+   ```bash
+   datacommons admin ingest start
+   ```
+
+---
+
+License: [Apache-2.0](https://github.com/datacommonsorg/datacommons/blob/main/LICENSE)

datacommons_cli-0.0.2/datacommons_cli/version.py → datacommons_cli-1.0.0/datacommons_cli/__init__.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.0.2"
+__version__ = "1.0.0"

datacommons_cli-1.0.0/datacommons_cli/cli.py

@@ -0,0 +1,74 @@
+# Copyright 2025 Google LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+
+import click
+
+from datacommons_admin.admin_cli import admin as admin_cli
+
+from . import __version__
+
+
+def get_logo_color():
+    """Determine the best logo color based on terminal capabilities"""
+    colorterm = os.environ.get("COLORTERM", "").lower()
+    if colorterm in ("truecolor", "24bit"):
+        return (7, 81, 179)
+
+    term = os.environ.get("TERM", "").lower()
+    if "256color" in term or colorterm:
+        return 26  # Royal blue color index in 256-color palette
+
+    return "blue"
+
+
+class CustomGroup(click.Group):
+    """Custom click.Group to preserve logo formatting and newlines in help text"""
+
+    def format_help_text(self, ctx, formatter):
+        if self.help:
+            formatter.write_paragraph()
+            with formatter.indentation():
+                for line in self.help.splitlines():
+                    if line:
+                        formatter.write(f"{' ' * formatter.current_indent}{line}\n")
+                    else:
+                        formatter.write("\n")
+
+
+def cli_help() -> str:
+    """Return help string for the CLI"""
+    logo = (
+        "    ██████╗   ██████╗\n"
+        "    ██╔══██╗ ██╔════╝\n"
+        "    ██║  ██║ ██║     \n"
+        "    ██║  ██║ ██║     \n"
+        "    ██████╔╝ ╚██████╗\n"
+        "    ╚═════╝   ╚═════╝"
+    )
+    styled_logo = click.style(logo, fg=get_logo_color(), bold=True)
+    version_str = click.style(f"v{__version__}", fg="bright_black")
+    return f"{styled_logo}\n\nData Commons CLI {version_str}"
+
+
+@click.group(cls=CustomGroup, help=cli_help())
+@click.version_option(version=__version__, prog_name="Data Commons CLI")
+def cli():
+    """Data Commons CLI"""
+    pass
+
+
+# Add admin CLI commands to the main CLI
+cli.add_command(admin_cli)

datacommons_cli-1.0.0/datacommons_cli.egg-info/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: datacommons-cli
+Version: 1.0.0
+Summary: Data Commons CLI
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1.7
+Requires-Dist: datacommons-admin
+
+# Data Commons CLI
+
+<p align="center">
+  <a href="https://www.datacommons.org"><img src="https://datacommons.org/images/dc-logo.svg" alt="Data Commons" width="120"></a>
+</p>
+
+<p align="center">
+  <em>Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.</em>
+</p>
+
+---
+
+[Data Commons](https://www.datacommons.org) is an open-source project initiated by Google that aggregates data from hundreds of public sources, such as the US Census, Eurostat, CDC, and UN, into a unified, standard Knowledge Graph.
+
+The **Data Commons Platform** provides the infrastructure to run your own private instance of Data Commons, allowing you to seamlessly combine public datasets with your own custom, private data using modern APIs, graph query engines, and visualization dashboards.
+
+---
+
+## Installation
+
+Install the Data Commons CLI using `pip` or `uv`:
+
+### Install with `pip`
+
+```bash
+pip install --user datacommons-cli
+```
+
+If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:
+
+```
+export PATH="$PATH:$(python3 -m site --user-base)/bin"
+```
+
+### Install with `uv`
+
+```bash
+uv tool install datacommons-cli
+```
+
+If the `datacommons` command is not found after installing, add the appropriate directory to your PATH:
+
+```
+export PATH="~/.local/bin:$PATH"
+```
+
+### With `uvx`
+
+Or execute `datacommons-cli` on-the-fly without installation using `uvx`:
+
+```bash
+uvx datacommons-cli --help
+```
+
+## Help & Documentation
+
+For full documentation, tutorials, and deployment guides, visit:
+👉 **[docs.datacommons.org](https://docs.datacommons.org)**
+
+---
+
+## Usage
+
+The CLI exposes standard operations under the main `datacommons` entrypoint. You can check the version and get help instantly:
+
+```bash
+# Show help menu
+datacommons --help
+
+# Show version
+datacommons --version
+```
+
+---
+
+## Administrative Commands
+
+All infrastructure setup, database operations, and ingestion pipelines are managed under the `admin` sub-command group:
+
+```bash
+datacommons admin [COMMAND] --help
+```
+
+### Available Commands
+
+| Command | Description |
+| --- | --- |
+| **`init`** | Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP). |
+| **`init-db`** | Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service. |
+| **`seed-db`** | Re-runs or updates base geographic and schema seeds on GCP Spanner. |
+| **`ingest start`** | Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets. |
+| **`ingest show-config`**| Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials. |
+
+### Quickstart: Scaffolding a Private Data Commons
+
+1. Initialize your project configuration and scaffold Terraform templates:
+   ```bash
+   datacommons admin init --project-id my-gcp-project --namespace prod
+   ```
+
+2. Change directories to the scaffolded directory (e.g. `cd prod`).
+
+3. Initialize and deploy your GCP infrastructure with Terraform:
+   ```bash
+   terraform init
+   terraform apply
+   ```
+
+4. Initialize and seed your Spanner database:
+   ```bash
+   datacommons admin init-db
+   ```
+
+5. Trigger the data ingestion pipeline:
+   ```bash
+   datacommons admin ingest start
+   ```
+
+---
+
+License: [Apache-2.0](https://github.com/datacommonsorg/datacommons/blob/main/LICENSE)

{datacommons_cli-0.0.2 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/SOURCES.txt

@@ -1,9 +1,11 @@
+README.md
 pyproject.toml
+datacommons_cli/__init__.py
 datacommons_cli/cli.py
-datacommons_cli/version.py
 datacommons_cli.egg-info/PKG-INFO
 datacommons_cli.egg-info/SOURCES.txt
 datacommons_cli.egg-info/dependency_links.txt
 datacommons_cli.egg-info/entry_points.txt
 datacommons_cli.egg-info/requires.txt
-datacommons_cli.egg-info/top_level.txt
+datacommons_cli.egg-info/top_level.txt
+tests/test_cli.py

{datacommons_cli-0.0.2 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 datacommons = datacommons_cli.cli:cli
+datacommons-cli = datacommons_cli.cli:cli

{datacommons_cli-0.0.2 → datacommons_cli-1.0.0}/pyproject.toml

@@ -16,6 +16,7 @@ urls = {Homepage = "https://github.com/datacommonsorg/datacommons"}
 
 [project.scripts]
 datacommons = "datacommons_cli.cli:cli"
+datacommons-cli = "datacommons_cli.cli:cli"
 
 [build-system]
 requires = ["uv", "setuptools"]
@@ -25,4 +26,4 @@ build-backend = "setuptools.build_meta"
 include-package-data = true
 
 [tool.setuptools.dynamic]
-version = {attr = "datacommons_cli.version.__version__"}
+version = {attr = "datacommons_cli.__version__"}

datacommons_cli-0.0.2/datacommons_cli/cli.py → datacommons_cli-1.0.0/tests/test_cli.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Google LLC.
+# Copyright 2026 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,16 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import click
+from click.testing import CliRunner
+from datacommons_cli.cli import cli, __version__
 
-from datacommons_admin.admin_cli import admin as admin_cli
 
+def test_cli_version() -> None:
+    runner = CliRunner()
+    result = runner.invoke(cli, ["--version"])
+    assert result.exit_code == 0
+    assert f"Data Commons CLI, version {__version__}" in result.output
 
-@click.group()
-def cli():
-    """Datacommons CLI suite"""
-    pass
 
-
-# Add schema CLI commands to the main CLI
-cli.add_command(admin_cli)
+def test_cli_help() -> None:
+    runner = CliRunner()
+    result = runner.invoke(cli, ["--help"])
+    assert result.exit_code == 0
+    assert "Data Commons CLI" in result.output

datacommons_cli-0.0.2/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 2.4
-Name: datacommons-cli
-Version: 0.0.2
-Summary: Data Commons CLI
-License-Expression: Apache-2.0
-Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: click>=8.1.7
-Requires-Dist: datacommons-admin

datacommons_cli-0.0.2/datacommons_cli.egg-info/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 2.4
-Name: datacommons-cli
-Version: 0.0.2
-Summary: Data Commons CLI
-License-Expression: Apache-2.0
-Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: click>=8.1.7
-Requires-Dist: datacommons-admin