AskAnna CLI & Python SDK is part of the AskAnna platform to kickstart your data science projects
Project description
AskAnna CLI & Python SDK
The AskAnna CLI offers a command-line interface to the AskAnna platform. With the Python SDK you can run AskAnna functions directly from your Python script. The CLI & Python SDK 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. Or open directly the documentation for:
Quickstart
Install AskAnna
pip install askanna
Update AskAnna
pip install -U 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 }}
Credits
Tools used in the AskAnna package:
History
0.9.0 (2021-05-19)
- Give runs a name and description when you start them. More info in the documentation.
- Extend validation of
askanna.yml
with an informative check on the time zone. - Update dataclasses of API responses where we removed the
UUID
andtitle
. We now only show the short UUID andname
. - In API request add
askanna-agent
andaskanna-agent-version
to inform the platform with which tool and version the request is done. - Added a check if a new version of AskAnna is available. For example, if you run
askanna --version
and a new version is available, we show an informative message how you can update. - Removed deprecated functions and files.
- Updated dependencies and removed the superfluous dependency
appdir
. - Make
askanna variable add
interactive, so you don't have to look-up the project SUUID to add a variable. - Changing the name of a workspace or project can now also be done via the CLI.
- Install
tzdata
in the default container-image to make it possible to set the time zone of the run environment. - Fix retrieval of runs with
askanna.run.get
withinclude_metrics=True
on.
0.8.0 (2021-04-15)
- Added track_variable and track_variables: from now on you can track variables for your runs. Also run environment variables are tracked.
- Added validation for
askanna.yml
to check job names and schedule definitions - Change name and description of a job via the CLI (
askanna job change
) or Python SDK (askanna.job.change
)
0.7.0 (2021-03-18)
- Adding track_metric and track_metrics: from now on you can track metrics for your runs, both ran on AskAnna servers and local runs.
- Regrouped commands used for the askanna-runner under it's own command
askanna-run-utils
instead ofaskanna
- Improvements in the client on how the AskAnna SDK communicates with the AskAnna API
- Update PyYAML library from 5.3 to 5.4.1
0.6.2 (2021-03-08)
- Make
askanna init
more friendly to use - Refer to open source project on GitLab.com
- Tweak configuration and README
0.6.1 (2021-02-11)
- Update references to the new documentation of AskAnna
0.6.0 (2021-02-03)
- Added push-and-run via
askanna run --push
where you first push your code and then trigger a run - Installed gcc in the default image we run on AskAnna
- Added developer option to specicy on which AskAnna remote you want to login
- Changes in parameter names for Python SDK (run.status and variable modules). If you used the 0.5.x version of the AskAnna Python SDK this version can break your code.
0.5.1 (2021-01-27)
- Fix that you can run a job with name and additional options
0.5.0 (2021-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 asaskanna create
0.4.2 (2020-12-22)
- Fix issue in
askanna init
which now generates a validaskanna.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
toaskanna 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 code package
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for askanna-0.9.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4e56468b80055e209833cd31ff647e791401c1c11e928e1b149ab6f0239c980 |
|
MD5 | 3ce05eacb3a2fa573333b81c7e8ebb11 |
|
BLAKE2b-256 | 5220b489f5cbcf2f08e8fe3a69f62ba5b61e8dcba162acf52269d6ca8d0e164e |