askanna 0.5.1

AskAnna CLI is part of the AskAnna platform to kickstart your data science projects

AskAnna CLI

The AskAnna CLI offers a command-line interface to the AskAnna platform. It simplifies the communication with the AskAnna platform and provides facilities for supporting every part of a data science project.

Documentation

For the latest version check the AskAnna Documentation.

Quickstart

Install AskAnna

pip install askanna

Login to askanna

askanna login

This will create a .askanna.yml in your home folder.

When used in a CI, one can configure authentication by setting an environment variable:

export AA_REMOTE=https://beta-api.askanna.eu/v1/
export AA_TOKEN={{ API TOKEN }}

The API token can be found in the created .askanna.yml file or in the curl information on a job run page in the AskAnna platform.

How to push your code to AskAnna

First add a askanna.yml file to the main directory of your project. In AskAnna create a project, copy the push-target and add it to the askanna.yml file.

Next run askanna push and your code will be uploaded to the project in AskAnna.

You can also push code from a CI environment. This requires the following environment variables to be set:

export AA_TOKEN={{ API TOKEN }}

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Make a new release

We use bumpversion to bump the version number of a release:

# upgrade version by 0.0.x
bumpversion patch

# upgrade version by 0.x.0
bumpversion minor

# upgrade version by x.0.0
bumpversion major

Credits

Tools used in the AskAnna package:

• Cookiecutter: https://github.com/audreyr/cookiecutter
• cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage

History

0.5.1 (2020-01-27)

• Fix that you can run a job with name and additional options

0.5.0 (2020-01-26)

• Use askanna run job_name to run a job
• Start of AskAnna Python SDK with support for:
  • starting a run
  • getting the status of a run
  • management of project variables
  • listing jobs
• Refactor code base to support SDK and remove some unused functions
• In askanna.yml allow output/artifact to specify which files & directories you want to save

0.4.3 (2020-12-25)

• askanna create --template will allow you to use your own template to create a new project
• Fix askanna create so it will actually create a project
• Update askanna init so it uses to same flow as askanna create

0.4.2 (2020-12-22)

• Fix issue in askanna init which now generates a valid askanna.yml project config file
• Improvements regarding feedback and error messages when something goes wrong
• Fix issues regarding generating AskAnna config file

0.4.1 (2020-12-01)

• Use Python to create a tmp directory so it works on all Python supported platforms

0.4.0 (2020-11-26)

• Adding variable management for CLI
• Drop support for Python 3.5 because we use dataclasses
• Reorganisation of CLI setup in the code base to prepare for SDK development
• Reorganize how authentication and requests are made for all API communication
• Adding logout for CLI

0.3.1 (2020-10-23)

• Improve artifact download to be more reliable in case of download failures

0.3.0 (2020-07-31)

• Changed askanna artifact to askanna artifact add
• Adding askanna artifact get
• Adding askanna variable list to get a list of variables in askanna
• Adding askanna variable change to modify the value of a variable

0.2.0 (2020-07-23)

• A default confirm question to confirm that you want to replace the current code package
• Added askanna push --force to skip the confirm question
• Added an optional argument to push add a message askanna push -m "push message"
• If no push messages provided, but a commit message is available, use the last commit message
• Changing how .askanna.yml is created
• Adding AskAnna functions for running in job
• Adding first test to check on push-target
• Download payload with CLI

0.1.0 (2019-12-05)

• First commit to repo
• Basic function to do askanna login
• First version of askanna package