Ansible role to use as a wrapper for pip to install python packages.
Full documentation on Readthedocs.
Source code on:
Ingredients
Ansible role to use as a wrapper for pip to install python packages.
This role performs the following actions:
- Ensure the requirements are installed.
- Ensure the current user can obtain administrative (root)
- permissions.
- Update the apt cache.
- Ensure dependencies are installed.
- If the packages_pip variable is defined, install the python
- packages listed on it.
- If the configuration variable is defined, install the python
- packages listed on it.
- To install and execute:
ansible-galaxy install constrict0r.pyp ansible localhost -m include_role -a name=constrict0r.pyp -K
- Passing variables:
ansible localhost -m include_role -a name=constrict0r.pyp -K \
-e "{packages_pip: ['bottle==0.12.17', 'whisper']}"
- To include the role on a playbook:
- hosts: servers
roles:
- {role: constrict0r.pyp}
- To include the role as dependency on another role:
dependencies:
- role: constrict0r.pyp
packages_pip: ['bottle==0.12.17', 'whisper']
- To use the role from tasks:
- name: Execute role task.
import_role:
name: constrict0r.pyp
vars:
packages_pip: ['bottle==0.12.17', 'whisper']
To run tests:
cd pyp chmod +x testme.sh ./testme.sh
On some tests you may need to use sudo to succeed.
The following variables are supported:
List of packages to install via pip.
This list can be modified by passing a packages_pip array when including the role on a playbook or via –extra-vars from a terminal.
If you want to install a specific package version, append the version to the package name.
This variable is empty by default.
# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.pyp -K -e \
"{packages_pip: ['bottle==0.12.17', 'whisper']}"
# Including on a playbook.
- hosts: servers
roles:
- role: constrict0r.pyp
packages_pip:
- bottle==0.12.17
- whisper
# To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e \
"{packages_pip: ['bottle==0.12.17', 'whisper']}"
Absolute file path or URL to a .yml file that contains all or some of the variables supported by this role.
It is recommended to use a .yml or .yaml extension for the configuration file.
This variable is empty by default.
# Using file path.
ansible localhost -m include_role -a name=constrict0r.pyp -K -e \
"configuration=/home/username/my-config.yml"
# Using URL.
ansible localhost -m include_role -a name=constrict0r.pyp -K -e \
"configuration=https://my-url/my-config.yml"
To see how to write a configuration file see the YAML file format section.
When passing configuration files to this role as parameters, it’s recommended to add a .yml or .yaml extension to the each file.
It is also recommended to add three dashes at the top of each file:
---
You can include in the file the variables required for your tasks:
--- packages_pip: - ['bottle==0.12.17', 'whisper']
If you want this role to load list of items from files and URLs you can set the expand variable to true:
--- packages_pip: /home/username/my-config.yml expand: true
If the expand variable is false, any file path or URL found will be treated like plain text.
If you want to run the tests, you will also need:
- The packages are installed globally.
MIT. See the LICENSE file for more details.
The full project structure is shown below:
The project data flow is shown below:
The Travelling Vaudeville Villain.
Enjoy!!!
