https://github.com/globocom/azkaban-cli
CLI for Azkaban 3 API access and flow upload.
https://github.com/globocom/azkaban-cli
Last synced: 10 months ago
JSON representation
CLI for Azkaban 3 API access and flow upload.
- Host: GitHub
- URL: https://github.com/globocom/azkaban-cli
- Owner: globocom
- License: mit
- Created: 2018-11-19T13:55:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T20:36:58.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T08:36:35.906Z (over 1 year ago)
- Language: Python
- Size: 312 KB
- Stars: 20
- Watchers: 59
- Forks: 19
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Azkaban CLI
[](https://travis-ci.com/globocom/azkaban-cli)
[](https://github.com/psf/black)
CLI for Azkaban 3 API access and flow upload.
## Install
Use virtualenv or conda env
```sh
### Building virtualenv
virtualenv azkaban_cli
### Activating virtualenv
source azkaban_cli/bin/activate
### Installing Azkaban CLI
pip install azkaban_cli
```
## Usage
Activate your virtualenv and call ```azkaban```
```
$ azkaban --help
Usage: azkaban [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
add_permission Add a group with permission in a project
change_permission Change a group permission in a project
create Create a new project
delete Delete a project
execute Execute a flow from a project
cancel Cancel a flow execution
fetch_running_executions_of_a_flow Fetch the running executions of a flow
fetch_flow_execution Fetch a flow execution
fetch_flow_execution_updates Fetch flow execution updates
fetch_execution_of_a_flow Fetch all execution of a given flow
fetch_jobs_from_flow Fetch jobs of a flow
fetch_execution_job_log Fetches the correponding job logs
fetch_projects Fetch all project from a user
fetch_sla Fetch the SLA from a schedule
login Login to an Azkaban server
logout Logout from Azkaban session
remove_permission Remove group permission from a project
schedule Schedule a flow from a project with specified cron...
unschedule Unschedule a flow from a project
upload Generates a zip of path passed as argument and...
```
## Environment setting
User session files are saved by default in the directory "$HOME/.azkaban_cli" directory.
This directory can be changed setting the environment variable AZKABAN_CLI_PATH .
## Examples
### Making login (this login cache information and don't need to do again)
```sh
azkaban login --host https://azkaban.your_company.com
```
## Contribute
For development and contributing, please follow [Contributing Guide](https://github.com/globocom/azkaban-cli/blob/master/CONTRIBUTING.md) and ALWAYS respect the [Code of Conduct](https://github.com/globocom/azkaban-cli/blob/master/CODE_OF_CONDUCT.md)