Skip to content

Commit 314dcba

Browse files
adjust readme
1 parent f80dbc1 commit 314dcba

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python Base Repository
22

3-
A Python project template that emphasizes developer experience and code quality.
3+
A Python project template that emphasizes developer experience and code quality.
44
This repository provides a consistent, containerized development environment with best-practice tooling pre-configured.
55

66
## Features
@@ -18,31 +18,30 @@ This repository provides a consistent, containerized development environment wit
1818
## Setup
1919

2020
1. Install [Docker](https://www.docker.com/get-started) and [VS Code](https://code.visualstudio.com/)
21-
2. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in VS Code
22-
3. Clone this repository:
21+
2. Clone this repository:
2322
```bash
2423
git clone https://github.com/matthiaszimmermann/python-base.git
2524
```
26-
4. Open the project in VS Code:
25+
3. Open the project in VS Code:
2726
```bash
2827
code python-base
2928
```
30-
5. When prompted, click "Reopen in Container"
29+
4. When prompted, click "Reopen in Container"
3130

3231
## Development Workflow
3332

3433
### Code Quality Tools
3534

3635
The project uses `ruff` for both linting and formatting. Run the following command to check your code:
3736
```bash
38-
ruff check
37+
uv run ruff check
3938
```
4039

4140
### Testing
4241

4342
Run the test suite with:
4443
```bash
45-
pytest
44+
uv run pytest
4645
```
4746

4847
### Logging
@@ -78,7 +77,8 @@ python src/main.py '{"id":42,"name":"Bob","email":"bob@example.com"}'
7877

7978
This repository follows modern Python development practices. All configuration is centralized in `pyproject.toml` for maintainability. Before contributing:
8079

81-
1. Ensure your code passes all linting checks (`ruff check`)
82-
2. Add tests for new functionality
83-
3. Update documentation as needed
84-
4. Verify all CI checks pass
80+
1. Ensure your code passes all linting checks (`uv run ruff check`)
81+
2. Ensure your code passes all existing unit tests (`uv run pytest`)
82+
3. Add tests for new functionality
83+
4. Update documentation as needed
84+
5. Verify all CI checks pass

0 commit comments

Comments
 (0)