Ansible Role: Pipenv

Role to download and install Pipenv the package manager for Python that combines pip with Virtualenv.

Requirements

• Ansible >= 2.8

• Linux Distribution

  • Debian Family

    • Ubuntu

      • Bionic (18.04)
      • Focal (20.04)

Role Variables

The following variables will change the behavior of this role (default values are shown below):

# Users to install Pipenv for
pipenv_users: []

Example Playbook

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

Tab Completion for Zsh

Using Ansible

We recommend using the gantsign.antigen role to enable tab completion for Pipenv (this must be configured 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 prefer to use Antigen directly add the following to your Antigen configuration:

antigen bundle gantsign/zsh-plugins pipenv

Manual configuration

To manually configure Zsh add the following to your .zshrc:

eval "$(_PIPENV_COMPLETE=zsh_source pipenv)"

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

To develop or test you'll need to have installed the following:

• Linux (e.g. Ubuntu)
• Docker
• Python (including python-pip)
• Ansible
• Molecule

Because the above can be tricky to install, this project includes Molecule Wrapper. Molecule Wrapper is a shell script that installs Molecule and it's dependencies (apart from Linux) and then executes Molecule with the command you pass it.

To test this role using Molecule Wrapper run the following command from the project root:

./moleculew test

Note: some of the dependencies need sudo permission to install.

License

MIT

Author Information

John Freeman

GantSign Ltd. Company No. 06109112 (registered in England)