Skip to content

Commit

Permalink
update docs + checking script
Browse files Browse the repository at this point in the history
  • Loading branch information
ADBond committed Sep 12, 2024
1 parent d6bab3c commit 16ebe55
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ from splinkclickhouse import ChDBAPI
See [getting started script](./scripts/getting_started_chdb.py) for example of use:

```sh
poetry run python scripts/getting_started_chdb.py
uv run python scripts/getting_started_chdb.py
```

### Clickhouse instance
Expand All @@ -37,21 +37,21 @@ docker-compose -f scripts/docker-compose.yaml up
See [getting started script](./scripts/getting_started_clickhouse.py) for example of use:

```sh
poetry run python scripts/getting_started_clickhouse.py
uv run python scripts/getting_started_clickhouse.py
```

## Dev setup

Get dependencies

```sh
poetry install
uv sync
```

Update dev dependencies

```sh
poetry lock
uv lock
```

Check package (with `ruff` and `mypy`)
Expand All @@ -63,24 +63,24 @@ Check package (with `ruff` and `mypy`)
Run all pytest tests

```sh
poetry run python -m pytest -vx tests
uv run python -m pytest -vx tests
```

You can run just the tests with `chdb` (for instance if you do not have clickhouse), or just `clickhouse`, by passing the `-m` flag

```sh
poetry run python -m pytest -vxm chdb tests
uv run python -m pytest -vxm chdb tests
# or the clickhouse tests:
poetry run python -m pytest -vxm clickhouse tests
uv run python -m pytest -vxm clickhouse tests
```

For clickhouse tests you will need to have docker container running.

Run test scripts

```sh
poetry run python scripts/getting_started_chdb.py
poetry run python scripts/getting_started_clickhouse.py
uv run python scripts/getting_started_chdb.py
uv run python scripts/getting_started_clickhouse.py
```

## Known issues
Expand Down
6 changes: 3 additions & 3 deletions scripts/check_package.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

set -euo pipefail

poetry run ruff check splinkclickhouse && poetry run ruff format splinkclickhouse
poetry run mypy splinkclickhouse
uv run python -m ruff check splinkclickhouse && uv run python -m ruff format splinkclickhouse
uv run python -m mypy splinkclickhouse

poetry run ruff check tests && poetry run ruff format tests
uv run python -m ruff check tests && uv run python -m ruff format tests

0 comments on commit 16ebe55

Please sign in to comment.