ansible-development-environ.../roles/python_pip
Robert de Bock ea83f6a426 Add update_pip_packages 2021-03-20 12:53:57 +01:00
..
.github Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
.github 2 Add update_pip_packages 2021-03-20 12:53:57 +01:00
defaults Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
meta Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
meta 2 Add update_pip_packages 2021-03-20 12:53:57 +01:00
molecule/default Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
molecule 2/default Add update_pip_packages 2021-03-20 12:53:57 +01:00
tasks Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
vars Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
.ansible-lint Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
.gitignore Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
.gitignore 2 Add update_pip_packages 2021-03-20 12:53:57 +01:00
.travis.yml Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
.yamllint Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
CODE_OF_CONDUCT.md Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
CONTRIBUTING.md Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
LICENSE Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
README.md Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
SECURITY.md Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
requirements 2.yml Add update_pip_packages 2021-03-20 12:53:57 +01:00
requirements.yml Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00
tox.ini Fix for: role name invalid format: robertdebock.investigate 2020-09-28 15:24:21 +02:00

README.md

python_pip

Install pythons pip on your system.

Travis GitHub Quality Downloads Version
travis github quality downloads Version

Example Playbook

This example is taken from molecule/resources/converge.yml and is tested on each push, pull request and release.

---
- name: Converge
  hosts: all
  become: yes
  gather_facts: yes

  roles:
    - role: robertdebock.python_pip

The machine may need to be prepared using molecule/resources/prepare.yml:

---
- name: Prepare
  hosts: all
  gather_facts: no
  become: yes

  roles:
    - role: robertdebock.bootstrap
    - role: robertdebock.epel
    - role: robertdebock.buildtools

For verification molecule/resources/verify.yml runs after the role has been applied.

---
- name: Verify
  hosts: all
  become: yes
  gather_facts: no

  tasks:
    - name: install pip module
      pip:
        name: docker
        state: present

    - name: check if bootstrap still works.
      include_role:
        name: robertdebock.bootstrap

    - name: remove pip module
      pip:
        name: docker
        state: absent

    - name: check if requested modules can be installed
      include_role:
        name: robertdebock.python_pip
      vars:
        python_pip_modules:
          - name: docker

Also see a full explanation and example on how to use these roles.

Role Variables

These variables are set in defaults/main.yml:

---
# defaults file for python_pip

# By default no modules should be installed.
python_pip_modules: []

# Connect to a (pypi) proxy by setting this variable.
# python_pip_proxy: "https://user:password@proxy:8443/artifactory/pypi/pypi-virtual/simple"

# Don't forget to trust foreign pip repositories if you use them.
# python_pip_trusted_host: my-pip-repository.example.com

Requirements

  • Access to a repository containing packages, likely on the internet.
  • A recent version of Ansible. (Tests run on the current, previous and next release of Ansible.)

The following roles can be installed to ensure all requirements are met, using ansible-galaxy install -r requirements.yml:

---
- robertdebock.bootstrap
- robertdebock.buildtools
- robertdebock.epel

Context

This role is a part of many compatible roles. Have a look at the documentation of these roles for further information.

Here is an overview of related roles: dependencies

Compatibility

This role has been tested on these container images:

container tags
alpine all
el 7, 8
debian buster, bullseye
fedora 31, 32
opensuse all
ubuntu focal, bionic, xenial

The minimum version of Ansible required is 2.8 but tests have been done to:

  • The previous version, on version lower.
  • The current version.
  • The development version.

Exceptions

Some variarations of the build matrix do not work. These are the variations and reasons why the build won't work:

variation reason
amazonline:1 ImportError: No module named pkg_resources
amazonline ImportError: No module named pkg_resources

Testing

Unit tests are done on every commit, pull request, release and periodically.

If you find issues, please register them in GitHub

Testing is done using Tox and Molecule:

Tox tests multiple ansible versions. Molecule tests multiple distributions.

To test using the defaults (any installed ansible version, namespace: robertdebock, image: fedora, tag: latest):

molecule test

# Or select a specific image:
image=ubuntu molecule test
# Or select a specific image and a specific tag:
image="debian" tag="stable" tox

Or you can test multiple versions of Ansible, and select images: Tox allows multiple versions of Ansible to be tested. To run the default (namespace: robertdebock, image: fedora, tag: latest) tests:

tox

# To run CentOS (namespace: `robertdebock`, tag: `latest`)
image="centos" tox
# Or customize more:
image="debian" tag="stable" tox

License

Apache-2.0

Contributors

I'd like to thank everybody that made contributions to this repository. It motivates me, improves the code and is just fun to collaborate.

Author Information

Robert de Bock

Please consider sponsoring me.