cleanup devcontainer setup

Author: matthiaszimmermann

.devcontainer/Dockerfile

@@ -3,6 +3,7 @@ FROM python:3.12-slim-bookworm
 # Install system dependencies
 RUN apt-get update && apt-get install -y \
     --no-install-recommends \
+    nano \
     curl \
     ca-certificates
 

.devcontainer/devcontainer.json

@@ -9,10 +9,21 @@
     "customizations": {
         "vscode": {
             "settings": {
+                "git.editor": "nano",
+                "files.insertFinalNewline": true,
+                "files.trimTrailingWhitespace": true,
                 "python.defaultInterpreterPath": "/workspace/.venv/bin/python",
                 "python.terminal.activateEnvironment": true,
                 "python.formatting.provider": "ruff",
-                "editor.formatOnSave": true
+                "[python]": {
+                    "editor.codeActionsOnSave": {
+                        "source.fixAll": "explicit",
+                        "source.organizeImports": "explicit"
+                    },
+                    "editor.defaultFormatter": "charliermarsh.ruff",
+                    "editor.formatOnSave": true,
+                    "editor.tabSize": 4
+                }
             },
             "extensions": [
                 "ms-python.python",
@@ -24,5 +35,5 @@
             ]
         }
     },
-    "postCreateCommand": "uv sync --dev"
+    "postCreateCommand": "uv sync && git config --global core.editor nano"
 }

.vscode/extensions.json

@@ -1,36 +1,43 @@
-# Python Base Repository
+# Pyton Base Repository
 
-Initial python project setup with Devcontainers, CI pipeline and the Serde library.
+Initial Python project setup with Devcontainers, CI pipeline and the Pydantic library.
 
-## Overview
-This repository is based on [github.com/a5chin/python-uv](https://github.com/a5chin/python-uv). Check its readme for the main layout of this repository.
+## Setup
 
-## TODO
-- Improve documentation
-- Add logging support
-
-## Appendix
-
-### Run Tests
-```sh
-uv run pytest
+1. Install [Docker](https://www.docker.com/get-started) and [VS Code](https://code.visualstudio.com/)
+2. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in VS Code
+3. Clone this repository:
+```bash
+git clone https://github.com/matthiaszimmermann/python-base.git
+```
+4. Open the project in VS Code:
+```bash
+code python-base
 ```
+5. When prompted, click "Reopen in Container"
 
-### Install Libraries
-```sh
-# Install also include develop dependencies
-uv sync
+## TODO
 
-# If you do not want dev dependencies to be installed
-uv sync --no-dev
+- remove .vscode folder (move to .devcontainer/devcontainer.json)
+- streamline gihub setup/pipelines
+- add user test
 
-# Use the add command to add dependencies to your project
-uv add {libraries}
+## Usage
+Once the dev container is built and running, you can use the integrated terminal in VS Code to run commands.
+
+### Formatting
+```bash
+ruff check
 ```
 
-## Run Command Line
+### Running Tests
+To run all tests:
+```bash
+pytest
+```
 
+## Run Example
 ```sh
-uv run python src/main.py 42 Bob bob@example.com
-uv run python src/main.py '{"id":42,"name":"Bob","email":"bob@example.com"}'
+python src/main.py 42 Bob bob@example.com
+python src/main.py '{"id":42,"name":"Bob","email":"bob@example.com"}'
 ```

.vscode/settings.json

@@ -0,0 +1 @@
+# noqa: D104