Skip to content

Commit 432ff51

Browse files
committed
chore: update README
1 parent 7e72158 commit 432ff51

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# Ansible Python Install
22

3-
Install Python on Ubuntu and RedHat based systems with Posit's pre-compiled binaries ([docs](https://docs.posit.co/resources/install-python/))
3+
Install Python (with Jupyter) on Ubuntu and RedHat based systems with Posit's pre-compiled binaries ([docs](https://docs.posit.co/resources/install-python/))
44

55
[![CI](https://github.com/Appsilon/ansible-python-install/workflows/CI/badge.svg)](https://github.com/Appsilon/ansible-python-install/actions/workflows/ci.yml)
66
[![Ansible Galaxy](https://img.shields.io/badge/ansible--galaxy-appsilon.python_install-blue.svg)](https://galaxy.ansible.com/appsilon/python_install)
77

88
## Requirements
99

10-
None.
10+
If you want to install Workbench's plugins, then the Python used for Jupyter installation needs to be >= 3.7
1111

1212
## Role Variables
1313

14-
| Variable | Required | Default | Choices | Comments |
15-
|-----------------|----------|------------------|-----------------------------------|---------------------------------------|
16-
| python_versions | yes | [3.10.6, 3.9.13] | Array with Python versions >= 3.7 | Version have to be specified as 3.x.y |
17-
| python_jupyter_kernel | no | true | Boolean: true, false | Makes Python available as a Jupyter Kernel |
14+
| Variable | Default | Choices | Comments |
15+
|-----------------|------------------|-----------------------------------|---------------------------------------|
16+
| python_versions | [3.10.6, 3.9.13] | Array with Python versions >= 3.7 | Version have to be specified as 3.x.y |
17+
| python_jupyter_kernel | true | Boolean: true, false | Makes Python available as a Jupyter Kernel |
18+
| python_jupyter_install | true | Boolean: true, false | Whether to install Jupyter |
19+
| python_jupyter_install_method | virtualenv | String: virtualenv, system | Method of Jupyter installation |
20+
| python_jupyter_python_version | `"{{ python_versions[0] }}"` | One of the versions passed in python_versions | Used only for virtualenv method |
21+
| python_jupyter_workbench | true | Boolean: true, false | Whether to install Workbench's plugins for Jupyter |
1822

1923
## Dependencies
2024

defaults/main.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ python_jupyter_install: true
88
# Possible values: system, virtualenv
99
python_jupyter_install_method: virtualenv
1010
# Python version to use for Jupyter installation
11+
# when using virtualenv method
1112
python_jupyter_python_version: "{{ python_versions[0] }}"
1213
python_jupyter_virtualenv_path: /opt/jupyter
1314
python_jupyter_packages:

0 commit comments

Comments
 (0)