Python Codespace

A starter Python project configured for GitHub Codespaces. This repository includes a development container configuration that provides a consistent Python development environment.

Note: If you already have a codespace open, you can jump to the Things to try section.

Setting up the development container

GitHub Codespaces

Follow these steps to open this project in a Codespace:

1. Click the Code drop-down menu.
2. Click on the Codespaces tab.
3. Click Create codespace on main.

For more information on creating your codespace, visit the GitHub documentation.

Dependencies from requirements.txt are installed automatically when the codespace is created.

VS Code Dev Containers

If you already have VS Code and Docker installed, you can use the Dev Containers extension:

1. If this is your first time using a development container, please ensure your system meets the prerequisites (i.e. have Docker installed) in the getting started steps.

2. Clone this repository to your local filesystem.

3. Press F1 and select the Dev Containers: Open Folder in Container... command.

4. Select the cloned copy of this folder, wait for the container to start, and try things out!

Things to try

Once you have this project opened in a codespace or dev container, you'll be able to work with it like you would locally.

Some things to try:

Edit

• Open src/main.py
• Try adding some code and check out the language features.
• Notice that utilities like the Python extension and Pylance are installed. These extensions are automatically installed because they are referenced in .devcontainer/devcontainer.json.

Terminal

• Press Ctrl+Shift+\`` (or Cmd+Shift+`` on Mac) to open a terminal window.

• Run the application:

  python -m src.main

  Or:

  python src/main.py

• You should see the output: Hello from Python Codespace!

Build, Run, and Debug

• Open src/main.py
• Add a breakpoint (e.g., on line 2 inside the main() function).
• Press F5 to launch the app in the container.
• Once the breakpoint is hit, try hovering over variables, examining locals, and more.

Add dependencies

• Edit requirements.txt to add Python packages you need.
• Rebuild your container for the changes to take effect:
  • Press F1 and select Dev Containers: Rebuild Container or Codespaces: Rebuild Container.

Project structure

.
├── .devcontainer/
│   └── devcontainer.json    # Dev container configuration
├── src/
│   ├── __init__.py          # Package initialization
│   └── main.py              # Main entry point
├── requirements.txt         # Python dependencies
├── .gitignore              # Git ignore rules
└── README.md               # This file

More resources

• GitHub Codespaces documentation
• Dev Containers documentation
• Python extension for VS Code