Metadata-Version: 2.4
Name: datazone
Version: 1.0.1
Summary: Datazone Client Package
Author: resulyurttakalan
Author-email: resul@datazone.co
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: pyspark
Requires-Dist: bson (>=0.5,<0.6)
Requires-Dist: click (==8.1.3)
Requires-Dist: clickhouse-connect (>=0.8,<0.9)
Requires-Dist: deltalake (>=0.25.5,<0.26.0)
Requires-Dist: fernet (>=1.0.1,<2.0.0)
Requires-Dist: gitpython (>=3.1.31,<4.0.0)
Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
Requires-Dist: loguru (>=0.7.2,<0.8.0)
Requires-Dist: numpy (==1.26.4)
Requires-Dist: oauthlib (>=3.2.2,<4.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: pydantic (>=2.0,<3.0)
Requires-Dist: pyspark (>=3.3.2,<4.0.0) ; extra == "pyspark"
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: questionary (>=2.0.1,<3.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
Description-Content-Type: text/markdown

Datazone Client Library 👋

## Installation

You can install package via pip

```shell
pip install datazone
```

## Configuration & Login

Run the following command in your terminal to create a new profile.

```shell
datazone profile create
```

When prompted, enter the following information:

```shell
Profile Name: <PROFILE_NAME>
Host [app.datazone.co]: <DATAZONE_ADDRESS>
API Key: <API Key>
```

Then you can run following command to test it. (At the first profile creation, it will test automatically)

```shell
datazone auth test
```

## Create first repository

```shell
datazone repository create hello-world
cd hello-world
```

It creates a new folder in your current directory. Thıs folder has two file initially. `config.yaml` and `first_pipeline.py`.
After you modify your script you can deploy project via following command.

```shell
datazone repository deploy
```

After the deployment is complete, you can check your repository status via following command.

```shell
datazone repository summary
```

If repository has deployed, you can run your first execution with following command.

```shell
datazone execution run <pipeline_id>
```

## Commands

Also you can check all command with help sub command. `datazone auth --help` or `datazone repository summary --help`

```shell
# Auth
datazone auth test

# Profile
datazone profile list
datazone profile create
datazone profile delete <profile_name>
datazone profile setdefault <profile_name>

# Repository
datazone repository list
datazone repository create
datazone repository deploy
datazone repository summary <file_name>
datazone repository clone <repository_id>
datazone repository pull

# Dataset
datazone dataset list
datazone dataset show <dataset_id> [--size <n>] [--transaction-id <id>] [--query "<SQL>"]
datazone dataset transactions <dataset_id>

# Source
datazone source create
datazone source list
datazone source update <source_id>
datazone source delete <source_id>

# Extract
datazone extract create
datazone extract list
datazone extract update <extract_id>
datazone extract delete <extract_id>
datazone extract execute <extract_id>

# Schedule
datazone schedule create
datazone schedule list
datazone schedule delete <source_id>

# Execution
datazone execution run [--extract-id] [--pipeline-id] [<execution_type>] [<transform_selection>]
datazone execution list [--extract-id] [--pipeline-id]
datazone execution log <execution_id>

# Pipeline
datazone pipeline create
datazone pipeline list
datazone pipeline delete <pipeline_id>

# View
datazone view create
datazone view list [--dataset-id <dataset_id>]
datazone view delete <view_id>

# SQL
datazone sql <dataset_id> "<QUERY>" [--transaction-id <id>] [--size <n>]

# Project
datazone project activities list <project_id>

# Flow
datazone flow list [--branch <branch>] [--project-id <project_id>]
datazone flow show <flow_id> [--branch <branch>]
datazone flow create [--name <name>] [--project-id <project_id>] [--file <definition.yml>]
datazone flow delete <flow_id>
datazone flow run <flow_id> [--parameters '<json>'] [--branch <branch>]
datazone flow validate --file <document.yml>
datazone flow node-types [<node_type>] [--schema]
datazone flow templates [<template_id>]
datazone flow runs list <flow_id>
datazone flow runs show <run_id>
datazone flow runs logs <run_id> [--node-id <node_id>]
datazone flow runs cancel <run_id>
datazone flow schedule list [--flow-id <flow_id>]
datazone flow schedule create <flow_id> --name <name> --expression "<cron>"
datazone flow schedule update <schedule_id> [--expression "<cron>"] [--active/--inactive]
datazone flow schedule delete <schedule_id>

# Knowledge Object
datazone knowledge-object list [--branch <branch>] [--project-id <project_id>]
datazone knowledge-object show <object_id>
datazone knowledge-object create [--project-id <project_id>] [--file <metadata.yml>]
datazone knowledge-object delete <object_id>
datazone knowledge-object instance list <object_id> [--fields <a,b>] [--filters <expr>]
datazone knowledge-object instance get <object_id> <key> [--with-relationships]
datazone knowledge-object instance create <object_id> --data '<json>' | --file <file>
datazone knowledge-object instance batch <object_id> --file <instances.yml>
datazone knowledge-object instance update <object_id> <key> --data '<json>'
datazone knowledge-object instance delete <object_id> <key>
datazone knowledge-object instance history <object_id> <key>

# Query Explorer
datazone query execute "<QUERY>" --project-id <project_id> [--tab-id <tab_id>]
datazone query results [<result_id>] [--project-id <project_id>]
datazone query saved list|show|create|update|delete
datazone query tab list|show|create|delete

# Variable & Tag
datazone variable list|show|create|delete
datazone tag list|show|create|delete

# Notebook & Kernel
datazone notebook list|show|create|delete
datazone notebook kernel start <notebook_id> [--type <type>] [--compute <size>]
datazone notebook kernel show|stop|restart|interrupt <kernel_id>
datazone notebook kernel active <notebook_id>
datazone notebook kernel history <notebook_id>

# Alert, Action & Agent
datazone alert list|show|create|delete
datazone alert test --query "<QUERY>" --project-id <project_id>
datazone alert events [--alert-id <alert_id>]
datazone action list|show|delete
datazone action test <action_id> [--parameters '<json>'] [--timeout <seconds>]
datazone action calls [--action-id <action_id>]
datazone agent list|show|delete
datazone agent models
datazone agent logs <agent_id> [--question-id <question_id>]

# Vector
datazone vector list|show|delete
datazone vector search <vector_id> "<term>" [--limit <n>]
datazone vector reindex <vector_id>

# Intelligent App Reports
datazone app report list|show|delete
datazone app report trigger <report_id>
datazone app report records [--report-id <report_id>]

# Target, Model Account & Notification Channel
datazone target list|show|create|delete
datazone model-account list|show|create|delete
datazone notification-channel list|show|create|delete

# Transaction & Favorite
datazone transaction list <dataset_id>
datazone transaction show <transaction_id>
datazone transaction daily-activity <dataset_id>
datazone favorite list
datazone favorite add <entity_id> --type <ENTITY_TYPE>
datazone favorite remove <entity_id>

# Users, Roles & Policies
datazone user list|show|create|delete
datazone user me
datazone user invite <email> [--role-id <role_id>]
datazone user permissions
datazone role list|show|create|delete
datazone role assign-user <role_id> <user_id>
datazone role assign-policy <role_id> <policy_id>
datazone role assigned-users|assigned-policies <role_id>
datazone policy list|show|create|update|delete
datazone policy assigned-roles <policy_id>

# Organisation & Keys
datazone organisation current
datazone organisation list
datazone organisation settings [<organisation_id>]
datazone organisation usage [<organisation_id>] [--detail]
datazone organisation audit-logs [--from-date <date>] [--to-date <date>]
datazone organisation subscription-status
datazone organisation quota list|create|update|delete
datazone api-key list|create|delete
datazone access-key list|create|delete
datazone access-key validate <access_key_id> <secret_key_id>

# System
datazone system health
datazone system version
datazone system settings

# Common
datazone version
datazone info
```

