File azkaban.py is well documented with docstrings. However, some of the information in there is wrong with regards to the returns. Some are missing, some are incorrect... This issue is related to fixing all the docstrings so that they correspond to the expected outcome of each function call.

Add the corresponding API call, as documented in the Azkaban project

Given an execution id, this API call fetches all the detailed information of that execution, including a list of all the job executions.

Some tests have declarations that are unnecessary to be declared, like:

def tearDown(self):
    pass

Add the Fetch Executions of a Flow API call, as documented in the Azkaban project

Given a project name, and a certain flow, this API call provides a list of corresponding executions.

Hi,
Could you please add LICENSE file and put the copyright holder and license inside each file?

This way there is no chance of someone stumbling across a piece of code without being exposed to the license.

Thanks!

I would like to inform you that currently this project is not participating in the hacktoberfest 2020 for not having the hacktoberfest topic added. contributors who send PR's for this project will receive the symbol below on their PR's:

To participate, just add the topic hacktoberfest to the repo, and hacktoberfest-accepted for accepted PR's.

Thanks in advance, happy coding ♥

Now ReadTheDocs is already integrated, but not with documentation there.

There are already some documentation as docstring, but ReadTheDocs is not well integrated.

We have to follow the https://azkaban.github.io/azkaban/docs/latest/#api-resume-a-flow-execution

It's necessary to enhance the cli commands to support the fetch of an SLA for a job schedule.

We have to follow the https://azkaban.github.io/azkaban/docs/latest/#api-fetch-sla

Add the corresponding API call, as documented in the Azkaban project

This API call fetches the updated information for an execution. It filters by lastUpdateTime which only returns job information updated afterwards.

Add the Fetch Running Executions of a Flow API call, as documented in the Azkaban project

Given a project name and a flow id, this API call fetches only executions that are currently running.

Azkaban schedule command let you pass some execution options. One of them (concurrent_option) is already supported.

@login_required
def __schedule(ctx, project, flow, cron, concurrent_option):
    azkaban = ctx.obj[u'azkaban']

    try:
        azkaban.schedule(project, flow, cron, concurrentOption=concurrent_option)
    except ScheduleError as e:
        logging.error(str(e))

But others (like failureAction) is not supported yet.

All execution options allowed can be found here: https://azkaban.readthedocs.io/en/latest/ajaxApi.html#execute-a-flow

I was trying to run the project and the following error occurred:

Traceback (most recent call last):
  File "/Workspace/vrs/my_azkaban/bin/azkaban", line 6, in <module>
    from azkaban_cli.azkaban_cli import cli
  File "/Workspace/vrs/my_azkaban/lib/python3.5/site-packages/azkaban_cli/azkaban_cli.py", line 618, in <module>
    @click.argument(u'start', type=click.INTEGER, default=0, show_default=True)
AttributeError: module 'click' has no attribute 'INTEGER'

Looking further I realize that the error was caused by #54

@click.argument(u'start', type=click.INTEGER, default=0, show_default=True)
@click.argument(u'length', type=click.INTEGER, default=3, show_default=True)

INTEGER isn't a valid click parameter type, click.INT should be used instead. Also show_default belongs to click.Option and should not be called in click.Argument

The project only contains the requirements.txt file for all app and test requirements.

They should be separated into two different files, avoiding unnecessary installation of libraries (like responses).

Add the corresponding API call, as documented in the Azkaban project

Given an execution id and a job id, this API call fetches the correponding job logs. The log text can be quite large sometimes, so this API call also expects the parameters offset and length to be specified.

Add the corresponding API call, as documented in the Azkaban project

Given a project name, this API call fetches all flow ids of that project.

Readme.md [Usage section] :
There is no syntax highlight required, only irrelevant keywords are getting highlighted, which can be confusing at time.

For example these keywords :

logout jobs in

whereas they are equally important as other words.
So, removing shell commands highlighting from a specific section might be useful.

Overview of the issue

Add pre-commit to the project, with black and flake8 set up.

Motivation for or Use Case

I believe that standardizing the project code style is a good practice, so we can use black and flake8, a useful tool for this purpose is pre-commit. I would like to configure this tool in the project as part of my contributions to hacktober fest.

We have to follow the https://azkaban.github.io/azkaban/docs/latest/#api-pause-a-flow-execution

Today, versioning is done manually by changing the __version__.py file and then running the make release command.

Versioning should be a part of the release process.

Add the Cancel a Flow Execution API call, as documented in the Azkaban project

Given an execution id, this API call cancels a running flow. If the flow is not running, it will return an error message.

It's necessary to enhance the cli commands to support the set of an SLA for a job schedule.

We have to follow the https://azkaban.github.io/azkaban/docs/latest/#api-set-sla

Upgrade requests version to 2.21.*

azkaban_cli keeps track of your last login, and only requires the password if your session has expired.

But whenever you need to send a command to another environment, you need to perform a new login, where is asked for host, user and password

It would be interesting if azkaban_cli could keep track of multiple environments and if there was an easy selection between them

The CONTRIBUTING.md divide the installation process into two steps:

1 - pip install -e .
2 - make test

It could misslead contributors. The comand pip install -e . install the dependences described in requirements.txt and under the setup.py install_requires atribute:

• requests
• click
• beautifulsoup4

Ain't nothing wrong until here. But when you move to the next step (make test) the test suit doesn't run properly. The majority of the tests rely on the responses module but this module would not be installed by running pip install -e .

The responses dependency is under setup.py > tests_require but pip install -e . won't reach that line. To properly run the make test I need to pip install -r requirements-dev.txt.

Should this be described at CONTRIBUTING.md or there's some other way to install everything at once.

With azkaban cli we can schedule flows but we can't unchedule.

It would be practical a command just like schedule, using project name and flow name as parameters.

Example:

azkaban schedule {project} {flow} {cron}

azkaban unschedule {project} {flow}

Add the Fetch Jobs of a Flow API call, as documented in the Azkaban project

For a given project and a flow id, this API call fetches all the jobs that belong to this flow. It also returns the corresponding graph structure of those jobs.