Configuration files for software development workflows

Pipfile and/or Pipfile.lock - Install a Python environment

pipenv allows you to manage a virtual environment Python dependencies. When using pipenv, you end up with Pipfile and Pipfile.lock files. The lock file contains explicit details about the packages that has been installed that met the criteria within the Pipfile.

If both Pipfile and Pipfile.lock are found by repo2docker, the former will be ignored in favor of the lock file. Also note that these files distinguish packages and development packages and that repo2docker will install both kinds.

requirements.txt - Install a Python environment

This specifies a list of Python packages that should be installed in your environment. Our example requirements.txt file on GitHub shows a typical requirements file.

pyproject.toml - Install Python packages

To install your repository like a Python package, you may include a pyproject.toml file. repo2dockerinstalls pyproject.toml files by running pip install -e ..

setup.py - Install Python packages

Note

We recommend to use pyproject.toml as it is the recommended way since 2020 when PEPs 621 and 631 were accepted.

To install your repository like a Python package, you may include a setup.py file. repo2docker installs setup.py files by running pip install -e ..