Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explicitely refer to charmcraft dependency #162

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: explicitely refer to charmcraft dependency #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ fail. For instructions on deploying MLflow you can start with [this
guide](https://documentation.ubuntu.com/charmed-mlflow/en/latest/tutorial/mlflow-kubeflow/),
ignoring the EKS specific steps.

The tests are orchestrated by tox, that needs to be installed on the system. Tox will in turn run the `pytest` script that is stored in the `driver` folder. `tox` will be taking care of creating the python environment needed to run the driver scripts. However the scripts also depends on `pytest-operator`, which requires `juju` and `charmcraft` to be installed as well. Please refer to their respective documentation for more details on how to install these tools on various environments, i.e. the [how to manage Juju](https://canonical-juju.readthedocs-hosted.com/en/3.6/user/howto/manage-juju/) and the [setup charmcraft](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/set-up-charmcraft/) user guides.

## Run the tests

As mentioned before, when it comes to running the tests, you've got 2 options:
Expand Down