gantsign.pipenv

Ansible Role: Pipenv

This role installs Pipenv – a package manager for Python that combines pip and Virtualenv.

Requirements

Ansible version 2.8 or higher
A Linux distribution, specifically:
- Debian family, such as:
  - Ubuntu versions:
    - Bionic (18.04)
    - Focal (20.04)

Role Variables

You can customize the behavior of this role with the following variable (defaults are provided):

# List of users to install Pipenv for
pipenv_users: []

Example Playbook

Here's an example of how to use this role in a playbook:

- hosts: servers
  roles:
    - role: gantsign.pipenv
      pipenv_users:
        - example

Tab Completion for Zsh

Using Ansible

For tab completion with Pipenv, we suggest using the gantsign.antigen role (must be set for each user).

- hosts: servers
  roles:
    - role: gantsign.pipenv
      pipenv_users:
        - example

    - role: gantsign.antigen
      users:
        - username: example
          antigen_bundles:
            - name: pipenv
              url: gantsign/zsh-plugins
              location: pipenv

Using Antigen

If you want to directly use Antigen, add this to your Antigen configuration:

antigen bundle gantsign/zsh-plugins pipenv

Manual Configuration

For manual setup in Zsh, include this line in your .zshrc file:

eval "$(_PIPENV_COMPLETE=zsh_source pipenv)"

More Roles From GantSign

Explore additional roles by GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule for development and testing. The role is tested using Testinfra and pytest.

To develop or test, have the following set up:

Linux (e.g., Ubuntu)
Docker
Python (includes python-pip)
Ansible
Molecule

To simplify installation, this project includes Molecule Wrapper, which installs Molecule and its dependencies (except for the OS) and runs Molecule commands.

To test this role with Molecule Wrapper, run: