Set Up a Python Project with Virtual Environment

Beginner8 minTrending

Create an isolated Python environment with dependencies, linting, and a reproducible project structure ready for collaboration.

Prerequisites

-Python 3.8+ installed

Steps

Create the project directory

Create a new directory for your project and navigate into it.

$ mkdir myproject && cd myproject

Use a descriptive name that matches your package or application name.

Create a virtual environment

Creates an isolated Python environment in the .venv directory. This keeps project dependencies separate from your system Python.

$ python -m venv .venv

The .venv name is a widely adopted convention. Most editors and tools auto-detect it.

Activate the environment

Activates the virtual environment so pip and python commands use the isolated copy. Your shell prompt will change to indicate the active environment.

$ source .venv/bin/activate # Windows: .venv\Scripts\activate

You must activate the environment in every new terminal session. Forgetting to activate is the most common cause of 'module not found' errors.

Upgrade pip and install dependencies

Upgrade pip to the latest version and install your project dependencies. Always upgrade pip first to avoid compatibility warnings.

$ pip install --upgrade pip && pip install requests flask

Freeze dependencies to requirements.txt

Lock all installed packages and their exact versions into a requirements file. This ensures reproducible installs across machines and CI.

$ pip freeze > requirements.txt

Run this command every time you add or update a dependency to keep the file current.

Add .venv to .gitignore

Exclude the virtual environment directory from version control. Each developer should create their own .venv from requirements.txt.

$ echo '.venv/' >> .gitignore

Never commit the .venv directory. It contains platform-specific binaries that will not work on other machines.

Full Script

full-script.sh

#!/bin/bash
# Python project setup with virtual environment
set -e

PROJECT_NAME=${1:-myproject}
mkdir -p "$PROJECT_NAME" && cd "$PROJECT_NAME"

python -m venv .venv
source .venv/bin/activate

pip install --upgrade pip
pip install requests flask pytest ruff

pip freeze > requirements.txt

echo '.venv/' > .gitignore
echo '__pycache__/' >> .gitignore
echo '*.pyc' >> .gitignore
echo '.pytest_cache/' >> .gitignore

mkdir -p src tests
touch src/__init__.py tests/__init__.py

echo "Project '$PROJECT_NAME' created and ready."

FAQ

Discussion

Loading comments...

#!/bin/bash # Python project setup with virtual environment set -e PROJECT_NAME=${1:-myproject} mkdir -p "$PROJECT_NAME" && cd "$PROJECT_NAME" python -m venv .venv source .venv/bin/activate pip install --upgrade pip pip install requests flask pytest ruff pip freeze > requirements.txt echo '.venv/' > .gitignore echo '__pycache__/' >> .gitignore echo '*.pyc' >> .gitignore echo '.pytest_cache/' >> .gitignore mkdir -p src tests touch src/__init__.py tests/__init__.py echo "Project '$PROJECT_NAME' created and ready."