Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FROM python:3.13-slim

# Install UV
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/

# Install git
RUN apt-get update \
&& apt-get install -y --no-install-recommends git \
&& rm -rf /var/lib/apt/lists/*

# Install Python dependencies
WORKDIR /workspaces/python-wiremock
COPY pyproject.toml uv.lock ./
ENV UV_PROJECT_ENVIRONMENT=/usr/local
RUN uv sync --frozen
16 changes: 16 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "Python Wiremock",
"build": {
"dockerfile": "Dockerfile",
"context": ".."
},
"overrideCommand": true,
"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"charliermarsh.ruff"
]
}
}
}
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff"
},
"editor.formatOnSave": true,
}
11 changes: 6 additions & 5 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,15 @@ General expectations:

## Development

We use [UV](https://docs.astral.sh/uv/) for packaging and dependency management.
We use **VSCode Dev Containers** for development.

After forking and cloning the repository,
run the following command to setup the project:
If you'd like to contribute:

`uv sync`
1. Follow [this tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial) to set up Dev Containers.
2. Once set up, open the `python-wiremock` folder in VSCode.
3. Use the **Dev Containers** extension to reopen the project inside the container.

Then use your favorite IDE for development and testing.
That's it - you'll have a ready-to-use development environment.

## Contributing examples

Expand Down