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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. datacommons_cli-1.0.0/PKG-INFO +132 -0
  2. datacommons_cli-1.0.0/README.md +121 -0
  3. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli/__init__.py +1 -1
  4. datacommons_cli-1.0.0/datacommons_cli.egg-info/PKG-INFO +132 -0
  5. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/SOURCES.txt +1 -0
  6. datacommons_cli-0.0.3/PKG-INFO +0 -10
  7. datacommons_cli-0.0.3/datacommons_cli.egg-info/PKG-INFO +0 -10
  8. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli/cli.py +0 -0
  9. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/dependency_links.txt +0 -0
  10. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/entry_points.txt +0 -0
  11. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/requires.txt +0 -0
  12. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/top_level.txt +0 -0
  13. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/pyproject.toml +0 -0
  14. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/setup.cfg +0 -0
  15. {datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/tests/test_cli.py +0 -0
datacommons_cli-1.0.0/PKG-INFO ADDED
@@ -0,0 +1,132 @@
1
+ Metadata-Version: 2.4
2
+ Name: datacommons-cli
3
+ Version: 1.0.0
4
+ Summary: Data Commons CLI
5
+ License-Expression: Apache-2.0
6
+ Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
7
+ Requires-Python: >=3.11
8
+ Description-Content-Type: text/markdown
9
+ Requires-Dist: click>=8.1.7
10
+ Requires-Dist: datacommons-admin
11
+
12
+ # Data Commons CLI
13
+
14
+ <p align="center">
15
+ <a href="https://www.datacommons.org"><img src="https://datacommons.org/images/dc-logo.svg" alt="Data Commons" width="120"></a>
16
+ </p>
17
+
18
+ <p align="center">
19
+ <em>Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.</em>
20
+ </p>
21
+
22
+ ---
23
+
24
+ [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.
25
+
26
+ 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.
27
+
28
+ ---
29
+
30
+ ## Installation
31
+
32
+ Install the Data Commons CLI using `pip` or `uv`:
33
+
34
+ ### Install with `pip`
35
+
36
+ ```bash
37
+ pip install --user datacommons-cli
38
+ ```
39
+
40
+ If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:
41
+
42
+ ```
43
+ export PATH="$PATH:$(python3 -m site --user-base)/bin"
44
+ ```
45
+
46
+ ### Install with `uv`
47
+
48
+ ```bash
49
+ uv tool install datacommons-cli
50
+ ```
51
+
52
+ If the `datacommons` command is not found after installing, add the appropriate directory to your PATH:
53
+
54
+ ```
55
+ export PATH="~/.local/bin:$PATH"
56
+ ```
57
+
58
+ ### With `uvx`
59
+
60
+ Or execute `datacommons-cli` on-the-fly without installation using `uvx`:
61
+
62
+ ```bash
63
+ uvx datacommons-cli --help
64
+ ```
65
+
66
+ ## Help & Documentation
67
+
68
+ For full documentation, tutorials, and deployment guides, visit:
69
+ 👉 **[docs.datacommons.org](https://docs.datacommons.org)**
70
+
71
+ ---
72
+
73
+ ## Usage
74
+
75
+ The CLI exposes standard operations under the main `datacommons` entrypoint. You can check the version and get help instantly:
76
+
77
+ ```bash
78
+ # Show help menu
79
+ datacommons --help
80
+
81
+ # Show version
82
+ datacommons --version
83
+ ```
84
+
85
+ ---
86
+
87
+ ## Administrative Commands
88
+
89
+ All infrastructure setup, database operations, and ingestion pipelines are managed under the `admin` sub-command group:
90
+
91
+ ```bash
92
+ datacommons admin [COMMAND] --help
93
+ ```
94
+
95
+ ### Available Commands
96
+
97
+ | Command | Description |
98
+ | --- | --- |
99
+ | **`init`** | Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP). |
100
+ | **`init-db`** | Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service. |
101
+ | **`seed-db`** | Re-runs or updates base geographic and schema seeds on GCP Spanner. |
102
+ | **`ingest start`** | Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets. |
103
+ | **`ingest show-config`**| Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials. |
104
+
105
+ ### Quickstart: Scaffolding a Private Data Commons
106
+
107
+ 1. Initialize your project configuration and scaffold Terraform templates:
108
+ ```bash
109
+ datacommons admin init --project-id my-gcp-project --namespace prod
110
+ ```
111
+
112
+ 2. Change directories to the scaffolded directory (e.g. `cd prod`).
113
+
114
+ 3. Initialize and deploy your GCP infrastructure with Terraform:
115
+ ```bash
116
+ terraform init
117
+ terraform apply
118
+ ```
119
+
120
+ 4. Initialize and seed your Spanner database:
121
+ ```bash
122
+ datacommons admin init-db
123
+ ```
124
+
125
+ 5. Trigger the data ingestion pipeline:
126
+ ```bash
127
+ datacommons admin ingest start
128
+ ```
129
+
130
+ ---
131
+
132
+ License: [Apache-2.0](https://github.com/datacommonsorg/datacommons/blob/main/LICENSE)
datacommons_cli-1.0.0/README.md ADDED
@@ -0,0 +1,121 @@
1
+ # Data Commons CLI
2
+
3
+ <p align="center">
4
+ <a href="https://www.datacommons.org"><img src="https://datacommons.org/images/dc-logo.svg" alt="Data Commons" width="120"></a>
5
+ </p>
6
+
7
+ <p align="center">
8
+ <em>Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.</em>
9
+ </p>
10
+
11
+ ---
12
+
13
+ [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.
14
+
15
+ 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.
16
+
17
+ ---
18
+
19
+ ## Installation
20
+
21
+ Install the Data Commons CLI using `pip` or `uv`:
22
+
23
+ ### Install with `pip`
24
+
25
+ ```bash
26
+ pip install --user datacommons-cli
27
+ ```
28
+
29
+ If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:
30
+
31
+ ```
32
+ export PATH="$PATH:$(python3 -m site --user-base)/bin"
33
+ ```
34
+
35
+ ### Install with `uv`
36
+
37
+ ```bash
38
+ uv tool install datacommons-cli
39
+ ```
40
+
41
+ If the `datacommons` command is not found after installing, add the appropriate directory to your PATH:
42
+
43
+ ```
44
+ export PATH="~/.local/bin:$PATH"
45
+ ```
46
+
47
+ ### With `uvx`
48
+
49
+ Or execute `datacommons-cli` on-the-fly without installation using `uvx`:
50
+
51
+ ```bash
52
+ uvx datacommons-cli --help
53
+ ```
54
+
55
+ ## Help & Documentation
56
+
57
+ For full documentation, tutorials, and deployment guides, visit:
58
+ 👉 **[docs.datacommons.org](https://docs.datacommons.org)**
59
+
60
+ ---
61
+
62
+ ## Usage
63
+
64
+ The CLI exposes standard operations under the main `datacommons` entrypoint. You can check the version and get help instantly:
65
+
66
+ ```bash
67
+ # Show help menu
68
+ datacommons --help
69
+
70
+ # Show version
71
+ datacommons --version
72
+ ```
73
+
74
+ ---
75
+
76
+ ## Administrative Commands
77
+
78
+ All infrastructure setup, database operations, and ingestion pipelines are managed under the `admin` sub-command group:
79
+
80
+ ```bash
81
+ datacommons admin [COMMAND] --help
82
+ ```
83
+
84
+ ### Available Commands
85
+
86
+ | Command | Description |
87
+ | --- | --- |
88
+ | **`init`** | Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP). |
89
+ | **`init-db`** | Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service. |
90
+ | **`seed-db`** | Re-runs or updates base geographic and schema seeds on GCP Spanner. |
91
+ | **`ingest start`** | Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets. |
92
+ | **`ingest show-config`**| Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials. |
93
+
94
+ ### Quickstart: Scaffolding a Private Data Commons
95
+
96
+ 1. Initialize your project configuration and scaffold Terraform templates:
97
+ ```bash
98
+ datacommons admin init --project-id my-gcp-project --namespace prod
99
+ ```
100
+
101
+ 2. Change directories to the scaffolded directory (e.g. `cd prod`).
102
+
103
+ 3. Initialize and deploy your GCP infrastructure with Terraform:
104
+ ```bash
105
+ terraform init
106
+ terraform apply
107
+ ```
108
+
109
+ 4. Initialize and seed your Spanner database:
110
+ ```bash
111
+ datacommons admin init-db
112
+ ```
113
+
114
+ 5. Trigger the data ingestion pipeline:
115
+ ```bash
116
+ datacommons admin ingest start
117
+ ```
118
+
119
+ ---
120
+
121
+ License: [Apache-2.0](https://github.com/datacommonsorg/datacommons/blob/main/LICENSE)
{datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli/__init__.py RENAMED
@@ -12,4 +12,4 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
- __version__ = "0.0.3"
15
+ __version__ = "1.0.0"
datacommons_cli-1.0.0/datacommons_cli.egg-info/PKG-INFO ADDED
@@ -0,0 +1,132 @@
1
+ Metadata-Version: 2.4
2
+ Name: datacommons-cli
3
+ Version: 1.0.0
4
+ Summary: Data Commons CLI
5
+ License-Expression: Apache-2.0
6
+ Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
7
+ Requires-Python: >=3.11
8
+ Description-Content-Type: text/markdown
9
+ Requires-Dist: click>=8.1.7
10
+ Requires-Dist: datacommons-admin
11
+
12
+ # Data Commons CLI
13
+
14
+ <p align="center">
15
+ <a href="https://www.datacommons.org"><img src="https://datacommons.org/images/dc-logo.svg" alt="Data Commons" width="120"></a>
16
+ </p>
17
+
18
+ <p align="center">
19
+ <em>Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.</em>
20
+ </p>
21
+
22
+ ---
23
+
24
+ [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.
25
+
26
+ 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.
27
+
28
+ ---
29
+
30
+ ## Installation
31
+
32
+ Install the Data Commons CLI using `pip` or `uv`:
33
+
34
+ ### Install with `pip`
35
+
36
+ ```bash
37
+ pip install --user datacommons-cli
38
+ ```
39
+
40
+ If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:
41
+
42
+ ```
43
+ export PATH="$PATH:$(python3 -m site --user-base)/bin"
44
+ ```
45
+
46
+ ### Install with `uv`
47
+
48
+ ```bash
49
+ uv tool install datacommons-cli
50
+ ```
51
+
52
+ If the `datacommons` command is not found after installing, add the appropriate directory to your PATH:
53
+
54
+ ```
55
+ export PATH="~/.local/bin:$PATH"
56
+ ```
57
+
58
+ ### With `uvx`
59
+
60
+ Or execute `datacommons-cli` on-the-fly without installation using `uvx`:
61
+
62
+ ```bash
63
+ uvx datacommons-cli --help
64
+ ```
65
+
66
+ ## Help & Documentation
67
+
68
+ For full documentation, tutorials, and deployment guides, visit:
69
+ 👉 **[docs.datacommons.org](https://docs.datacommons.org)**
70
+
71
+ ---
72
+
73
+ ## Usage
74
+
75
+ The CLI exposes standard operations under the main `datacommons` entrypoint. You can check the version and get help instantly:
76
+
77
+ ```bash
78
+ # Show help menu
79
+ datacommons --help
80
+
81
+ # Show version
82
+ datacommons --version
83
+ ```
84
+
85
+ ---
86
+
87
+ ## Administrative Commands
88
+
89
+ All infrastructure setup, database operations, and ingestion pipelines are managed under the `admin` sub-command group:
90
+
91
+ ```bash
92
+ datacommons admin [COMMAND] --help
93
+ ```
94
+
95
+ ### Available Commands
96
+
97
+ | Command | Description |
98
+ | --- | --- |
99
+ | **`init`** | Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP). |
100
+ | **`init-db`** | Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service. |
101
+ | **`seed-db`** | Re-runs or updates base geographic and schema seeds on GCP Spanner. |
102
+ | **`ingest start`** | Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets. |
103
+ | **`ingest show-config`**| Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials. |
104
+
105
+ ### Quickstart: Scaffolding a Private Data Commons
106
+
107
+ 1. Initialize your project configuration and scaffold Terraform templates:
108
+ ```bash
109
+ datacommons admin init --project-id my-gcp-project --namespace prod
110
+ ```
111
+
112
+ 2. Change directories to the scaffolded directory (e.g. `cd prod`).
113
+
114
+ 3. Initialize and deploy your GCP infrastructure with Terraform:
115
+ ```bash
116
+ terraform init
117
+ terraform apply
118
+ ```
119
+
120
+ 4. Initialize and seed your Spanner database:
121
+ ```bash
122
+ datacommons admin init-db
123
+ ```
124
+
125
+ 5. Trigger the data ingestion pipeline:
126
+ ```bash
127
+ datacommons admin ingest start
128
+ ```
129
+
130
+ ---
131
+
132
+ License: [Apache-2.0](https://github.com/datacommonsorg/datacommons/blob/main/LICENSE)
{datacommons_cli-0.0.3 → datacommons_cli-1.0.0}/datacommons_cli.egg-info/SOURCES.txt RENAMED
@@ -1,3 +1,4 @@
1
+ README.md
1
2
  pyproject.toml
2
3
  datacommons_cli/__init__.py
3
4
  datacommons_cli/cli.py
datacommons_cli-0.0.3/PKG-INFO DELETED
@@ -1,10 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: datacommons-cli
3
- Version: 0.0.3
4
- Summary: Data Commons CLI
5
- License-Expression: Apache-2.0
6
- Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
7
- Requires-Python: >=3.11
8
- Description-Content-Type: text/markdown
9
- Requires-Dist: click>=8.1.7
10
- Requires-Dist: datacommons-admin
datacommons_cli-0.0.3/datacommons_cli.egg-info/PKG-INFO DELETED
@@ -1,10 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: datacommons-cli
3
- Version: 0.0.3
4
- Summary: Data Commons CLI
5
- License-Expression: Apache-2.0
6
- Project-URL: Homepage, https://github.com/datacommonsorg/datacommons
7
- Requires-Python: >=3.11
8
- Description-Content-Type: text/markdown
9
- Requires-Dist: click>=8.1.7
10
- Requires-Dist: datacommons-admin