Skip to content

Commit b3a5ec9

Browse files
authored
feat: move to uv and update all the dependencies (#229)
BREAKING CHANGE: Move to uv from poetry and update all dependencies. Removed CircleCI badge from README. See #223
1 parent 6c65bae commit b3a5ec9

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
![CircleCI](https://img.shields.io/circleci/build/github/BSStudio/bss-web-file-api/main?label=build)
1+
[![Docker](https://github.com/BSStudio/bss-web-file-api/actions/workflows/docker.yml/badge.svg)](https://github.com/BSStudio/bss-web-file-api/actions/workflows/docker.yml)
2+
[![Integration test](https://github.com/BSStudio/bss-web-file-api/actions/workflows/integration.yml/badge.svg)](https://github.com/BSStudio/bss-web-file-api/actions/workflows/integration.yml)
3+
[![Python](https://github.com/BSStudio/bss-web-file-api/actions/workflows/python.yml/badge.svg)](https://github.com/BSStudio/bss-web-file-api/actions/workflows/python.yml)
24
![GitHub Release Date](https://img.shields.io/github/release-date/BSStudio/bss-web-file-api)
35
![GitHub Tag](https://img.shields.io/github/v/tag/BSStudio/bss-web-file-api)
46
![GitHub branch checks state](https://img.shields.io/github/checks-status/BSStudio/bss-web-file-api/main)
@@ -27,10 +29,10 @@ based on their uuid.
2729
### Pre-requisites
2830

2931
1. Install python (see version in pyproject.toml)
30-
2. Install poetry
32+
2. Install [uv](https://docs.astral.sh/uv/)
3133

3234
```shell
33-
poetry install
35+
uv sync
3436
```
3537

3638
### Set up commit hooks
@@ -42,38 +44,46 @@ pre-commit install
4244
## Run server
4345

4446
```shell
45-
uvicorn src.bss_web_file_server.main:app
47+
uv run uvicorn src.bss_web_file_server.main:app
4648
```
4749

4850
### Lint
4951

5052
```shell
51-
poetry run isort . --check
52-
poetry run black . --check
53-
poetry run mypy
54-
poetry run pylint src
53+
uv run isort . --check
54+
uv run black . --check
55+
uv run mypy
56+
uv run pylint src
5557
```
5658

5759
#### Apply lint
5860

5961
```shell
60-
poetry run isort .
61-
poetry run black .
62+
uv run isort .
63+
uv run black .
6264
```
6365

6466
### Run development server
6567

6668
```shell
67-
uvicorn src.bss_web_file_server.main:app --reload
69+
uv run uvicorn src.bss_web_file_server.main:app --reload
6870
```
6971

7072

7173
### Test
7274

7375
```shell
74-
poetry run pytest
76+
uv run pytest
7577
```
7678

79+
### Integration Test
80+
81+
```shell
82+
uv run pytest tests-int
83+
```
84+
85+
See [`.github/workflows/integration.yml`](.github/workflows/integration.yml) for CI/CD example with GitHub Actions.
86+
7787
### Build docker image
7888

7989
```shell

0 commit comments

Comments
 (0)