.. default-domain:: bash

================
Pipenv Functions
================

.. file:: pipenv_functions.bsh

Functions for working with pipenv files

.. function:: get_pipfile_hash

Print the hash of a Pipfile

Reproduces what pipenv internally calculates for the hash of a Pipfile.

:Arguments: ``$1`` - Pipfile filename
:Output: ``stdout`` - hex sha256 sum of Pipfile data
:Uses: Requires  ``python`` with ``pipenv``

.. note::

    Need to be run in the python environment (virtualenv)

.. seealso::

  :func:`get_pipfile_lock_hash`

.. function:: get_pipfile_lock_hash

Print the hash stored in a Pipfile.lock

:Arguments: ``$1`` - Pipfile.lock filename
:Output: ``stdout`` - hex sha256 sum of Pipfile data
:Uses: Requires ``python``

.. seealso::

  :func:`get_pipfile_hash`

.. function:: get_pipenv_virtualenv_location

Print the virtualenv location for a given Pipefile

:Arguments: ``$1`` - pipenv project root directory (directory and Pipfile do not need to exist)
:Output: ``stdout`` - Location where the virtualenv would be.
:Uses: Requires ``python``