pydoc > virtualenv

man perldoc info pydoc3 ri search

📛 NAME

virtualenv

🚀 Quick Reference

Use Case	Command	Description
Create virtual environment	cli_run(args)	Create a virtual environment from CLI arguments
Inspect session without creating	session_via_cli(args)	Preview what the virtual environment would look like
Get version	virtualenv.__version__	Returns the version string

📦 PACKAGE CONTENTS

• __main__
• activation (package)
• app_data (package)
• config (package)
• create (package)
• discovery (package)
• info
• report
• run (package)
• seed (package)
• util (package)
• version

⚙️ FUNCTIONS

• cli_run(args, options=None, setup_logging=True, env=None) — Create a virtual environment given some command line interface arguments.
  • args: the command line arguments
  • options: passing in a VirtualEnvOptions object allows return of the parsed options
  • setup_logging: True if setup logging handlers, False to use handlers already registered
  • env: environment variables to use
  • Return: the session object of the creation (its structure for now is experimental and might change on short notice)
• session_via_cli(args, options=None, setup_logging=True, env=None) — Create a virtualenv session (same as cli_run, but this does not perform the creation). Use this if you just want to query what the virtual environment would look like, but not actually create it.
  • args: the command line arguments
  • options: passing in a VirtualEnvOptions object allows return of the parsed options
  • setup_logging: True if setup logging handlers, False to use handlers already registered
  • env: environment variables to use
  • Return: the session object of the creation (its structure for now is experimental and might change on short notice)

📦 DATA

__all__ = ('__version__', 'cli_run', 'session_via_cli')

🏷️ VERSION

20.13.0+ds

📁 FILE

/usr/lib/python3/dist-packages/virtualenv/__init__.py

📛 NAME 🚀 Quick Reference 📦 PACKAGE CONTENTS ⚙️ FUNCTIONS 📦 DATA 🏷️ VERSION 📁 FILE